zephyr/drivers/ipm/ipm_mcux.c
Tomasz Bursztyka 4dcfb5531c isr: Normalize usage of device instance through ISR
The goal of this patch is to replace the 'void *' parameter by 'struct
device *' if they use such variable or just 'const void *' on all
relevant ISRs

This will avoid not-so-nice const qualifier tweaks when device instances
will be constant.

Note that only the ISR passed to IRQ_CONNECT are of interest here.

In order to do so, the script fix_isr.py below is necessary:

from pathlib import Path
import subprocess
import pickle
import mmap
import sys
import re
import os

cocci_template = """
@r_fix_isr_0
@
type ret_type;
identifier P;
identifier D;
@@
-ret_type <!fn!>(void *P)
+ret_type <!fn!>(const struct device *P)
{
 ...
(
 const struct device *D = (const struct device *)P;
|
 const struct device *D = P;
)
 ...
}

@r_fix_isr_1
@
type ret_type;
identifier P;
identifier D;
@@
-ret_type <!fn!>(void *P)
+ret_type <!fn!>(const struct device *P)
{
 ...
 const struct device *D;
 ...
(
 D = (const struct device *)P;
|
 D = P;
)
 ...
}

@r_fix_isr_2
@
type ret_type;
identifier A;
@@
-ret_type <!fn!>(void *A)
+ret_type <!fn!>(const void *A)
{
 ...
}

@r_fix_isr_3
@
const struct device *D;
@@
-<!fn!>((void *)D);
+<!fn!>(D);

@r_fix_isr_4
@
type ret_type;
identifier D;
identifier P;
@@
-ret_type <!fn!>(const struct device *P)
+ret_type <!fn!>(const struct device *D)
{
 ...
(
-const struct device *D = (const struct device *)P;
|
-const struct device *D = P;
)
 ...
}

@r_fix_isr_5
@
type ret_type;
identifier D;
identifier P;
@@
-ret_type <!fn!>(const struct device *P)
+ret_type <!fn!>(const struct device *D)
{
 ...
-const struct device *D;
...
(
-D = (const struct device *)P;
|
-D = P;
)
 ...
}
"""

def find_isr(fn):
    db = []
    data = None
    start = 0

    try:
        with open(fn, 'r+') as f:
            data = str(mmap.mmap(f.fileno(), 0).read())
    except Exception as e:
        return db

    while True:
        isr = ""
        irq = data.find('IRQ_CONNECT', start)
        while irq > -1:
            p = 1
            arg = 1
            p_o = data.find('(', irq)
            if p_o < 0:
                irq = -1
                break;

            pos = p_o + 1

            while p > 0:
                if data[pos] == ')':
                    p -= 1
                elif data[pos] == '(':
                    p += 1
                elif data[pos] == ',' and p == 1:
                    arg += 1

                if arg == 3:
                    isr += data[pos]

                pos += 1

            isr = isr.strip(',\\n\\t ')
            if isr not in db and len(isr) > 0:
                db.append(isr)

            start = pos
            break

        if irq < 0:
            break

    return db

def patch_isr(fn, isr_list):
    if len(isr_list) <= 0:
        return

    for isr in isr_list:
        tmplt = cocci_template.replace('<!fn!>', isr)
        with open('/tmp/isr_fix.cocci', 'w') as f:
            f.write(tmplt)

        cmd = ['spatch', '--sp-file', '/tmp/isr_fix.cocci', '--in-place', fn]

        subprocess.run(cmd)

def process_files(path):
    if path.is_file() and path.suffix in ['.h', '.c']:
        p = str(path.parent) + '/' + path.name
        isr_list = find_isr(p)
        patch_isr(p, isr_list)
    elif path.is_dir():
        for p in path.iterdir():
            process_files(p)

if len(sys.argv) < 2:
    print("You need to provide a dir/file path")
    sys.exit(1)

process_files(Path(sys.argv[1]))

And is run: ./fix_isr.py <zephyr root directory>

Finally, some files needed manual fixes such.

Fixes #27399

Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2020-09-02 13:48:13 +02:00

180 lines
4.2 KiB
C

/*
* Copyright (c) 2017-2018, NXP
*
* SPDX-License-Identifier: Apache-2.0
*/
#define DT_DRV_COMPAT nxp_lpc_mailbox
#include <errno.h>
#include <device.h>
#include <drivers/ipm.h>
#include <fsl_mailbox.h>
#include <fsl_clock.h>
#include <soc.h>
#define MCUX_IPM_DATA_REGS 1
#define MCUX_IPM_MAX_ID_VAL 0
#if defined(__CM4_CMSIS_VERSION)
#define MAILBOX_ID_THIS_CPU kMAILBOX_CM4
#define MAILBOX_ID_OTHER_CPU kMAILBOX_CM0Plus
#else
#define MAILBOX_ID_THIS_CPU kMAILBOX_CM0Plus
#define MAILBOX_ID_OTHER_CPU kMAILBOX_CM4
#endif
struct mcux_mailbox_config {
MAILBOX_Type *base;
void (*irq_config_func)(const struct device *dev);
};
struct mcux_mailbox_data {
ipm_callback_t callback;
void *callback_ctx;
};
static void mcux_mailbox_isr(const struct device *dev)
{
struct mcux_mailbox_data *data = dev->data;
const struct mcux_mailbox_config *config = dev->config;
mailbox_cpu_id_t cpu_id;
cpu_id = MAILBOX_ID_THIS_CPU;
volatile uint32_t value = MAILBOX_GetValue(config->base, cpu_id);
__ASSERT(value, "spurious MAILBOX interrupt");
/* Clear or the interrupt gets called intermittently */
MAILBOX_ClearValueBits(config->base, cpu_id, value);
if (data->callback) {
/* Only one MAILBOX, id is unused and set to 0 */
data->callback(dev, data->callback_ctx, 0, &value);
}
/* Add for ARM errata 838869, affects Cortex-M4, Cortex-M4F
* Store immediate overlapping exception return operation
* might vector to incorrect interrupt
*/
#if defined __CORTEX_M && (__CORTEX_M == 4U)
__DSB();
#endif
}
static int mcux_mailbox_ipm_send(const struct device *d, int wait,
uint32_t id,
const void *data, int size)
{
const struct mcux_mailbox_config *config = d->config;
MAILBOX_Type *base = config->base;
uint32_t data32[MCUX_IPM_DATA_REGS]; /* Until we change API
* to uint32_t array
*/
unsigned int flags;
int i;
ARG_UNUSED(wait);
if (id > MCUX_IPM_MAX_ID_VAL) {
return -EINVAL;
}
if (size > MCUX_IPM_DATA_REGS * sizeof(uint32_t)) {
return -EMSGSIZE;
}
flags = irq_lock();
/* Actual message is passing using 32 bits registers */
memcpy(data32, data, size);
for (i = 0; i < ARRAY_SIZE(data32); ++i) {
MAILBOX_SetValueBits(base, MAILBOX_ID_OTHER_CPU, data32[i]);
}
irq_unlock(flags);
return 0;
}
static int mcux_mailbox_ipm_max_data_size_get(const struct device *d)
{
ARG_UNUSED(d);
/* Only a single 32-bit register available */
return MCUX_IPM_DATA_REGS*sizeof(uint32_t);
}
static uint32_t mcux_mailbox_ipm_max_id_val_get(const struct device *d)
{
ARG_UNUSED(d);
/* Only a single instance of MAILBOX available for this platform */
return MCUX_IPM_MAX_ID_VAL;
}
static void mcux_mailbox_ipm_register_callback(const struct device *d,
ipm_callback_t cb,
void *context)
{
struct mcux_mailbox_data *driver_data = d->data;
driver_data->callback = cb;
driver_data->callback_ctx = context;
}
static int mcux_mailbox_ipm_set_enabled(const struct device *d, int enable)
{
/* For now: nothing to be done */
return 0;
}
static int mcux_mailbox_init(const struct device *dev)
{
const struct mcux_mailbox_config *config = dev->config;
MAILBOX_Init(config->base);
config->irq_config_func(dev);
return 0;
}
static const struct ipm_driver_api mcux_mailbox_driver_api = {
.send = mcux_mailbox_ipm_send,
.register_callback = mcux_mailbox_ipm_register_callback,
.max_data_size_get = mcux_mailbox_ipm_max_data_size_get,
.max_id_val_get = mcux_mailbox_ipm_max_id_val_get,
.set_enabled = mcux_mailbox_ipm_set_enabled
};
/* Config MAILBOX 0 */
static void mcux_mailbox_config_func_0(const struct device *dev);
static const struct mcux_mailbox_config mcux_mailbox_0_config = {
.base = (MAILBOX_Type *)DT_INST_REG_ADDR(0),
.irq_config_func = mcux_mailbox_config_func_0,
};
static struct mcux_mailbox_data mcux_mailbox_0_data;
DEVICE_AND_API_INIT(mailbox_0, DT_INST_LABEL(0),
&mcux_mailbox_init,
&mcux_mailbox_0_data, &mcux_mailbox_0_config,
PRE_KERNEL_1, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT,
&mcux_mailbox_driver_api);
static void mcux_mailbox_config_func_0(const struct device *dev)
{
IRQ_CONNECT(DT_INST_IRQN(0),
DT_INST_IRQ(0, priority),
mcux_mailbox_isr, DEVICE_GET(mailbox_0), 0);
irq_enable(DT_INST_IRQN(0));
}