zephyrproject-rtos/zephyr
0
0
Fork 0
mirror of https://github.com/zephyrproject-rtos/zephyr synced 2025-08-23 20:37:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
0b9c584ec1
zephyr/drivers/i2c/i2c_nios2.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

197 lines
4.5 KiB
C
Raw Blame History

/*
* Copyright (c) 2018 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#define DT_DRV_COMPAT nios2_i2c
#include <errno.h>
#include <drivers/i2c.h>
#include <soc.h>
#include <sys/util.h>
#include <altera_common.h>
#include "altera_avalon_i2c.h"
#define LOG_LEVEL CONFIG_I2C_LOG_LEVEL
#include <logging/log.h>
LOG_MODULE_REGISTER(i2c_nios2);
#define NIOS2_I2C_TIMEOUT_USEC 1000
#define DEV_CFG(dev) \
((struct i2c_nios2_config *)(dev)->config)
struct i2c_nios2_config {
ALT_AVALON_I2C_DEV_t i2c_dev;
IRQ_DATA_t irq_data;
struct k_sem sem_lock;
};
static int i2c_nios2_configure(const struct device *dev, uint32_t dev_config)
{
struct i2c_nios2_config *config = DEV_CFG(dev);
int32_t rc = 0;
k_sem_take(&config->sem_lock, K_FOREVER);
if (!(I2C_MODE_MASTER & dev_config)) {
LOG_ERR("i2c config mode error\n");
rc = -EINVAL;
goto i2c_cfg_err;
}
if (I2C_ADDR_10_BITS & dev_config) {
LOG_ERR("i2c config addressing error\n");
rc = -EINVAL;
goto i2c_cfg_err;
}
if (I2C_SPEED_GET(dev_config) != I2C_SPEED_STANDARD) {
LOG_ERR("i2c config speed error\n");
rc = -EINVAL;
goto i2c_cfg_err;
}
alt_avalon_i2c_init(&config->i2c_dev);
i2c_cfg_err:
k_sem_give(&config->sem_lock);
return rc;
}
static int i2c_nios2_transfer(const struct device *dev, struct i2c_msg *msgs,
uint8_t num_msgs, uint16_t addr)
{
struct i2c_nios2_config *config = DEV_CFG(dev);
ALT_AVALON_I2C_STATUS_CODE status;
uint32_t restart, stop;
int32_t i, timeout, rc = 0;
k_sem_take(&config->sem_lock, K_FOREVER);
/* register the optional interrupt callback */
alt_avalon_i2c_register_optional_irq_handler(
&config->i2c_dev, &config->irq_data);
/* Iterate over all the messages */
for (i = 0; i < num_msgs; i++) {
/* convert restart flag */
if (msgs->flags & I2C_MSG_RESTART) {
restart = ALT_AVALON_I2C_RESTART;
} else {
restart = ALT_AVALON_I2C_NO_RESTART;
}
/* convert stop flag */
if (msgs->flags & I2C_MSG_STOP) {
stop = ALT_AVALON_I2C_STOP;
} else {
stop = ALT_AVALON_I2C_NO_STOP;
}
/* Set the slave device address */
alt_avalon_i2c_master_target_set(&config->i2c_dev, addr);
/* Start the transfer */
if (msgs->flags & I2C_MSG_READ) {
status = alt_avalon_i2c_master_receive_using_interrupts(
&config->i2c_dev,
msgs->buf, msgs->len,
restart, stop);
} else {
status = alt_avalon_i2c_master_transmit_using_interrupts
(&config->i2c_dev,
msgs->buf, msgs->len,
restart, stop);
}
/* Return an error if the transfer didn't
* start successfully e.g., if the bus was busy
*/
if (status != ALT_AVALON_I2C_SUCCESS) {
LOG_ERR("i2c transfer error %lu\n", status);
rc = -EIO;
goto i2c_transfer_err;
}
timeout = NIOS2_I2C_TIMEOUT_USEC;
while (timeout) {
k_busy_wait(1);
status = alt_avalon_i2c_interrupt_transaction_status(
&config->i2c_dev);
if (status == ALT_AVALON_I2C_SUCCESS) {
break;
}
timeout--;
}
if (timeout <= 0) {
LOG_ERR("i2c busy or timeout error %lu\n", status);
rc = -EIO;
goto i2c_transfer_err;
}
/* move to the next message */
msgs++;
}
i2c_transfer_err:
alt_avalon_i2c_disable(&config->i2c_dev);
k_sem_give(&config->sem_lock);
return rc;
}
static void i2c_nios2_isr(const struct device *dev)
{
struct i2c_nios2_config *config = DEV_CFG(dev);
/* Call Altera HAL driver ISR */
alt_handle_irq(&config->i2c_dev, I2C_0_IRQ);
}
static int i2c_nios2_init(const struct device *dev);
static struct i2c_driver_api i2c_nios2_driver_api = {
.configure = i2c_nios2_configure,
.transfer = i2c_nios2_transfer,
};
static struct i2c_nios2_config i2c_nios2_cfg = {
.i2c_dev = {
.i2c_base = (alt_u32 *)DT_INST_REG_ADDR(0),
.irq_controller_ID = I2C_0_IRQ_INTERRUPT_CONTROLLER_ID,
.irq_ID = I2C_0_IRQ,
.ip_freq_in_hz = DT_INST_PROP(0, clock_frequency),
},
};
DEVICE_AND_API_INIT(i2c_nios2_0, DT_INST_LABEL(0), &i2c_nios2_init,
NULL, &i2c_nios2_cfg,
POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEVICE,
&i2c_nios2_driver_api);
static int i2c_nios2_init(const struct device *dev)
{
struct i2c_nios2_config *config = DEV_CFG(dev);
int rc;
/* initialize semaphore */
k_sem_init(&config->sem_lock, 1, 1);
rc = i2c_nios2_configure(dev,
I2C_MODE_MASTER |
I2C_SPEED_SET(I2C_SPEED_STANDARD));
if (rc) {
LOG_ERR("i2c configure failed %d\n", rc);
return rc;
}
/* clear ISR register content */
alt_avalon_i2c_int_clear(&config->i2c_dev,
ALT_AVALON_I2C_ISR_ALL_CLEARABLE_INTS_MSK);
IRQ_CONNECT(I2C_0_IRQ, CONFIG_I2C_0_IRQ_PRI,
i2c_nios2_isr, DEVICE_GET(i2c_nios2_0), 0);
irq_enable(I2C_0_IRQ);
return 0;
}
Reference in New Issue View Git Blame Copy Permalink