ipmi_si.h 2.9 KB

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