[mirror_ubuntu-jammy-kernel.git] / include / linux / irqchip.h

/*
 * Copyright (C) 2012 Thomas Petazzoni
 *
 * Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2.  This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#ifndef _LINUX_IRQCHIP_H
#define _LINUX_IRQCHIP_H

#include <linux/acpi.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>

/*
 * This macro must be used by the different irqchip drivers to declare
 * the association between their DT compatible string and their
 * initialization function.
 *
 * @name: name that must be unique across all IRQCHIP_DECLARE of the
 * same file.
 * @compstr: compatible string of the irqchip driver
 * @fn: initialization function
 */
#define IRQCHIP_DECLARE(name, compat, fn) OF_DECLARE_2(irqchip, name, compat, fn)

extern int platform_irqchip_probe(struct platform_device *pdev);

#define IRQCHIP_PLATFORM_DRIVER_BEGIN(drv_name) \
static const struct of_device_id drv_name##_irqchip_match_table[] = {

#define IRQCHIP_MATCH(compat, fn) { .compatible = compat, .data = fn },

#define IRQCHIP_PLATFORM_DRIVER_END(drv_name)				\
	{},								\
};									\
MODULE_DEVICE_TABLE(of, drv_name##_irqchip_match_table);		\
static struct platform_driver drv_name##_driver = {		\
	.probe  = platform_irqchip_probe,				\
	.driver = {							\
		.name = #drv_name,					\
		.owner = THIS_MODULE,					\
		.of_match_table = drv_name##_irqchip_match_table,	\
		.suppress_bind_attrs = true,				\
	},								\
};									\
builtin_platform_driver(drv_name##_driver)

/*
 * This macro must be used by the different irqchip drivers to declare
 * the association between their version and their initialization function.
 *
 * @name: name that must be unique across all IRQCHIP_ACPI_DECLARE of the
 * same file.
 * @subtable: Subtable to be identified in MADT
 * @validate: Function to be called on that subtable to check its validity.
 *            Can be NULL.
 * @data: data to be checked by the validate function.
 * @fn: initialization function
 */
#define IRQCHIP_ACPI_DECLARE(name, subtable, validate, data, fn)	\
	ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(irqchip, name,		\
					  ACPI_SIG_MADT, subtable,	\
					  validate, data, fn)

#ifdef CONFIG_IRQCHIP
void irqchip_init(void);
#else
static inline void irqchip_init(void) {}
#endif

#endif
Commit	Line	Data
f6e916b8 TP	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
46e589a3	14	#include <linux/acpi.h>
762a21fd	15	#include <linux/module.h>
91e20b50	16	#include <linux/of.h>
f8410e62	17	#include <linux/platform_device.h>
91e20b50 JP	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	*
c5f48c0a	24	* @name: name that must be unique across all IRQCHIP_DECLARE of the
91e20b50 JP	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
f8410e62 SK	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 = platform_irqchip_probe, \
	44	.driver = { \
	45	.name = #drv_name, \
	46	.owner = THIS_MODULE, \
	47	.of_match_table = drv_name##_irqchip_match_table, \
	48	.suppress_bind_attrs = true, \
	49	}, \
	50	}; \
	51	builtin_platform_driver(drv_name##_driver)
	52
46e589a3 MZ	53	/*
	54	* This macro must be used by the different irqchip drivers to declare
	55	* the association between their version and their initialization function.
	56	*
c5f48c0a	57	* @name: name that must be unique across all IRQCHIP_ACPI_DECLARE of the
46e589a3 MZ	58	* same file.
	59	* @subtable: Subtable to be identified in MADT
	60	* @validate: Function to be called on that subtable to check its validity.
	61	* Can be NULL.
	62	* @data: data to be checked by the validate function.
	63	* @fn: initialization function
	64	*/
	65	#define IRQCHIP_ACPI_DECLARE(name, subtable, validate, data, fn) \
aba3c7ed OC	66	ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(irqchip, name, \
	67	ACPI_SIG_MADT, subtable, \
	68	validate, data, fn)
46e589a3	69
0d7c1210	70	#ifdef CONFIG_IRQCHIP
f6e916b8	71	void irqchip_init(void);
0d7c1210 BH	72	#else
	73	static inline void irqchip_init(void) {}
	74	#endif
f6e916b8 TP	75
f6e916b8 TP	76	#endif