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