include/linux/irqchip.h

   1 /*
   2  * Copyright (C) 2012 Thomas Petazzoni
   3  *
   4  * Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
   5  *
   6  * This file is licensed under the terms of the GNU General Public
   7  * License version 2.  This program is licensed "as is" without any
   8  * warranty of any kind, whether express or implied.
   9  */
  10
  11 #ifndef _LINUX_IRQCHIP_H
  12 #define _LINUX_IRQCHIP_H
  13
  14 #include <linux/acpi.h>
  15 #include <linux/module.h>
  16 #include <linux/of.h>
  17 #include <linux/platform_device.h>
  18
  19 /*
  20  * This macro must be used by the different irqchip drivers to declare
  21  * the association between their DT compatible string and their
  22  * initialization function.
  23  *
  24  * @name: name that must be unique across all IRQCHIP_DECLARE of the
  25  * same file.
  26  * @compstr: compatible string of the irqchip driver
  27  * @fn: initialization function
  28  */
  29 #define IRQCHIP_DECLARE(name, compat, fn) OF_DECLARE_2(irqchip, name, compat, fn)
  30
  31 extern int platform_irqchip_probe(struct platform_device *pdev);
  32
  33 #define IRQCHIP_PLATFORM_DRIVER_BEGIN(drv_name) \
  34 static const struct of_device_id drv_name##_irqchip_match_table[] = {
  35
  36 #define IRQCHIP_MATCH(compat, fn) { .compatible = compat, .data = fn },
  37
  38 #define IRQCHIP_PLATFORM_DRIVER_END(drv_name)                           \
  39         {},                                                             \
  40 };                                                                      \
  41 MODULE_DEVICE_TABLE(of, drv_name##_irqchip_match_table);                \
  42 static struct platform_driver drv_name##_driver = {                     \
  43         .probe  = IS_ENABLED(CONFIG_IRQCHIP) ?                          \
  44                         platform_irqchip_probe : NULL,                  \
  45         .driver = {                                                     \
  46                 .name = #drv_name,                                      \
  47                 .owner = THIS_MODULE,                                   \
  48                 .of_match_table = drv_name##_irqchip_match_table,       \
  49                 .suppress_bind_attrs = true,                            \
  50         },                                                              \
  51 };                                                                      \
  52 builtin_platform_driver(drv_name##_driver)
  53
  54 /*
  55  * This macro must be used by the different irqchip drivers to declare
  56  * the association between their version and their initialization function.
  57  *
  58  * @name: name that must be unique across all IRQCHIP_ACPI_DECLARE of the
  59  * same file.
  60  * @subtable: Subtable to be identified in MADT
  61  * @validate: Function to be called on that subtable to check its validity.
  62  *            Can be NULL.
  63  * @data: data to be checked by the validate function.
  64  * @fn: initialization function
  65  */
  66 #define IRQCHIP_ACPI_DECLARE(name, subtable, validate, data, fn)        \
  67         ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(irqchip, name,                \
  68                                           ACPI_SIG_MADT, subtable,      \
  69                                           validate, data, fn)
  70
  71 #ifdef CONFIG_IRQCHIP
  72 void irqchip_init(void);
  73 #else
  74 static inline void irqchip_init(void) {}
  75 #endif
  76
  77 #endif