linux-stable/include/linux/isa.h
William Breathitt Gray 85ebe0afd3 isa: Introduce the module_isa_driver_with_irq helper macro
Several ISA drivers feature IRQ support that can configured via an "irq"
array module parameter. This array typically matches directly with the
respective "base" array module parameter. To reduce code repetition, a
module_isa_driver_with_irq helper macro is introduced to provide a check
ensuring that the number of "irq" passed to the module matches with the
respective number of "base".

Signed-off-by: William Breathitt Gray <william.gray@linaro.org>
Acked-by: William Breathitt Gray <william.gray@linaro.org>
Signed-off-by: Bartosz Golaszewski <brgl@bgdev.pl>
2022-09-15 10:28:18 +02:00

106 lines
3.3 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/*
* ISA bus.
*/
#ifndef __LINUX_ISA_H
#define __LINUX_ISA_H
#include <linux/device.h>
#include <linux/errno.h>
#include <linux/kernel.h>
struct isa_driver {
int (*match)(struct device *, unsigned int);
int (*probe)(struct device *, unsigned int);
void (*remove)(struct device *, unsigned int);
void (*shutdown)(struct device *, unsigned int);
int (*suspend)(struct device *, unsigned int, pm_message_t);
int (*resume)(struct device *, unsigned int);
struct device_driver driver;
struct device *devices;
};
#define to_isa_driver(x) container_of((x), struct isa_driver, driver)
#ifdef CONFIG_ISA_BUS_API
int isa_register_driver(struct isa_driver *, unsigned int);
void isa_unregister_driver(struct isa_driver *);
#else
static inline int isa_register_driver(struct isa_driver *d, unsigned int i)
{
return -ENODEV;
}
static inline void isa_unregister_driver(struct isa_driver *d)
{
}
#endif
#define module_isa_driver_init(__isa_driver, __num_isa_dev) \
static int __init __isa_driver##_init(void) \
{ \
return isa_register_driver(&(__isa_driver), __num_isa_dev); \
} \
module_init(__isa_driver##_init)
#define module_isa_driver_with_irq_init(__isa_driver, __num_isa_dev, __num_irq) \
static int __init __isa_driver##_init(void) \
{ \
if (__num_irq != __num_isa_dev) { \
pr_err("%s: Number of irq (%u) does not match number of base (%u)\n", \
__isa_driver.driver.name, __num_irq, __num_isa_dev); \
return -EINVAL; \
} \
return isa_register_driver(&(__isa_driver), __num_isa_dev); \
} \
module_init(__isa_driver##_init)
#define module_isa_driver_exit(__isa_driver) \
static void __exit __isa_driver##_exit(void) \
{ \
isa_unregister_driver(&(__isa_driver)); \
} \
module_exit(__isa_driver##_exit)
/**
* module_isa_driver() - Helper macro for registering a ISA driver
* @__isa_driver: isa_driver struct
* @__num_isa_dev: number of devices to register
*
* Helper macro for ISA drivers which do not do anything special in module
* init/exit. This eliminates a lot of boilerplate code. Each module may only
* use this macro once, and calling it replaces module_init and module_exit.
*/
#define module_isa_driver(__isa_driver, __num_isa_dev) \
module_isa_driver_init(__isa_driver, __num_isa_dev); \
module_isa_driver_exit(__isa_driver)
/**
* module_isa_driver_with_irq() - Helper macro for registering an ISA driver with irq
* @__isa_driver: isa_driver struct
* @__num_isa_dev: number of devices to register
* @__num_irq: number of IRQ to register
*
* Helper macro for ISA drivers with irq that do not do anything special in
* module init/exit. Each module may only use this macro once, and calling it
* replaces module_init and module_exit.
*/
#define module_isa_driver_with_irq(__isa_driver, __num_isa_dev, __num_irq) \
module_isa_driver_with_irq_init(__isa_driver, __num_isa_dev, __num_irq); \
module_isa_driver_exit(__isa_driver)
/**
* max_num_isa_dev() - Maximum possible number registered of an ISA device
* @__ida_dev_ext: ISA device address extent
*
* The highest base address possible for an ISA device is 0x3FF; this results in
* 1024 possible base addresses. Dividing the number of possible base addresses
* by the address extent taken by each device results in the maximum number of
* devices on a system.
*/
#define max_num_isa_dev(__isa_dev_ext) (1024 / __isa_dev_ext)
#endif /* __LINUX_ISA_H */