zephyr/drivers/interrupt_controller
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
..
CMakeLists.txt driver: intc: add MIWU driver support in NPCX series. 2020-09-01 13:35:25 +02:00
intc_arcv2_irq_unit.c device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
intc_cavs.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
intc_cavs.h device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
intc_dw.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
intc_dw.h device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
intc_exti_stm32.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
intc_gic_common_priv.h drivers: add GIC V3 driver 2020-05-07 14:22:53 +02:00
intc_gic.c drivers: interrupt_controller: GIC barrier before EOI 2020-06-28 23:47:58 -04:00
intc_gicv3_priv.h drivers: add GIC V3 driver 2020-05-07 14:22:53 +02:00
intc_gicv3.c drivers: interrupt_controller: gicv3: Skip typr for SGI 2020-07-01 08:02:57 -04:00
intc_ioapic_priv.h drivers/interrupt_controller: Adopt file naming as other drivers 2019-12-18 21:49:46 +01:00
intc_ioapic.c device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
intc_loapic_spurious.S drivers/interrupt_controller: Adopt file naming as other drivers 2019-12-18 21:49:46 +01:00
intc_loapic.c device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
intc_miwu.c device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
intc_plic.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
intc_rv32m1_intmux.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
intc_sam0_eic_priv.h zephyr: replace zephyr integer types with C99 types 2020-06-08 08:23:57 -05:00
intc_sam0_eic.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
intc_shared_irq.c device: Const-ify all device driver instance pointers 2020-09-02 13:48:13 +02:00
intc_swerv_pic.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
intc_system_apic.c zephyr: replace zephyr integer types with C99 types 2020-06-08 08:23:57 -05:00
intc_vexriscv_litex.c isr: Normalize usage of device instance through ISR 2020-09-02 13:48:13 +02:00
Kconfig driver: intc: add MIWU driver support in NPCX series. 2020-09-01 13:35:25 +02:00
Kconfig.cavs intc: intc_cavs: Use DTS labels for device names 2020-04-22 04:59:22 -05:00
Kconfig.dw interrupt_controller/dw_ictl: need to be initialized earlier 2020-03-25 19:07:28 -04:00
Kconfig.gic drivers: interrupt_controller: Refactor GIC configurations 2019-12-19 11:05:27 -05:00
Kconfig.loapic drivers/interrupt_controller: Split Kconfig for clarity 2019-12-18 21:49:46 +01:00
Kconfig.multilevel
Kconfig.multilevel.aggregator_template
Kconfig.npcx driver: intc: add MIWU driver support in NPCX series. 2020-09-01 13:35:25 +02:00
Kconfig.rv32m1
Kconfig.sam0 kconfig: Replace non-defconfig single-symbol 'if's with 'depends on' 2020-02-12 10:32:34 -06:00
Kconfig.shared_irq
Kconfig.stm32 drivers/exti: stm32: Add support for STM32L5 series 2020-05-08 00:34:34 -05:00