1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * ipmi_si.h 4 * 5 * Interface from the device-specific interfaces (OF, DMI, ACPI, PCI, 6 * etc) to the base ipmi system interface code. 7 */ 8 9 #ifndef __IPMI_SI_H__ 10 #define __IPMI_SI_H__ 11 12 #include <linux/ipmi.h> 13 #include <linux/interrupt.h> 14 #include <linux/platform_device.h> 15 16 #define SI_DEVICE_NAME "ipmi_si" 17 18 #define DEFAULT_REGSPACING 1 19 #define DEFAULT_REGSIZE 1 20 21 /* Numbers in this enumerator should be mapped to si_to_str[] */ 22 enum si_type { 23 SI_TYPE_INVALID, SI_KCS, SI_SMIC, SI_BT, SI_TYPE_MAX 24 }; 25 26 /* Array is defined in the ipmi_si_intf.c */ 27 extern const char *const si_to_str[]; 28 29 struct ipmi_match_info { 30 enum si_type type; 31 }; 32 33 extern const struct ipmi_match_info ipmi_kcs_si_info; 34 extern const struct ipmi_match_info ipmi_smic_si_info; 35 extern const struct ipmi_match_info ipmi_bt_si_info; 36 37 enum ipmi_addr_space { 38 IPMI_IO_ADDR_SPACE, IPMI_MEM_ADDR_SPACE 39 }; 40 41 /* 42 * The structure for doing I/O in the state machine. The state 43 * machine doesn't have the actual I/O routines, they are done through 44 * this interface. 45 */ 46 struct si_sm_io { 47 unsigned char (*inputb)(const struct si_sm_io *io, unsigned int offset); 48 void (*outputb)(const struct si_sm_io *io, 49 unsigned int offset, 50 unsigned char b); 51 52 /* 53 * Generic info used by the actual handling routines, the 54 * state machine shouldn't touch these. 55 */ 56 void __iomem *addr; 57 unsigned int regspacing; 58 unsigned int regsize; 59 unsigned int regshift; 60 enum ipmi_addr_space addr_space; 61 unsigned long addr_data; 62 enum ipmi_addr_src addr_source; /* ACPI, PCI, SMBIOS, hardcode, etc. */ 63 union ipmi_smi_info_union addr_info; 64 65 int (*io_setup)(struct si_sm_io *info); 66 void (*io_cleanup)(struct si_sm_io *info); 67 unsigned int io_size; 68 69 int irq; 70 int (*irq_setup)(struct si_sm_io *io); 71 void *irq_handler_data; 72 void (*irq_cleanup)(struct si_sm_io *io); 73 74 u8 slave_addr; 75 const struct ipmi_match_info *si_info; 76 struct device *dev; 77 }; 78 79 int ipmi_si_add_smi(struct si_sm_io *io); 80 irqreturn_t ipmi_si_irq_handler(int irq, void *data); 81 void ipmi_irq_start_cleanup(struct si_sm_io *io); 82 int ipmi_std_irq_setup(struct si_sm_io *io); 83 void ipmi_irq_finish_setup(struct si_sm_io *io); 84 void ipmi_si_remove_by_dev(struct device *dev); 85 struct device *ipmi_si_remove_by_data(int addr_space, enum si_type si_type, 86 unsigned long addr); 87 void ipmi_hardcode_init(void); 88 void ipmi_si_hardcode_exit(void); 89 void ipmi_si_hotmod_exit(void); 90 int ipmi_si_hardcode_match(int addr_space, unsigned long addr); 91 void ipmi_si_platform_init(void); 92 void ipmi_si_platform_shutdown(void); 93 void ipmi_remove_platform_device_by_name(char *name); 94 95 extern struct platform_driver ipmi_platform_driver; 96 97 #ifdef CONFIG_PCI 98 void ipmi_si_pci_init(void); 99 void ipmi_si_pci_shutdown(void); 100 #else 101 static inline void ipmi_si_pci_init(void) { } 102 static inline void ipmi_si_pci_shutdown(void) { } 103 #endif 104 #ifdef CONFIG_PARISC 105 void ipmi_si_parisc_init(void); 106 void ipmi_si_parisc_shutdown(void); 107 #else 108 static inline void ipmi_si_parisc_init(void) { } 109 static inline void ipmi_si_parisc_shutdown(void) { } 110 #endif 111 112 int ipmi_si_port_setup(struct si_sm_io *io); 113 int ipmi_si_mem_setup(struct si_sm_io *io); 114 115 #endif /* __IPMI_SI_H__ */ 116