internal.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /* Copyright (c) 2018-2021 Intel Corporation */
  3. #ifndef __PECI_INTERNAL_H
  4. #define __PECI_INTERNAL_H
  5. #include <linux/device.h>
  6. #include <linux/types.h>
  7. struct peci_controller;
  8. struct attribute_group;
  9. struct peci_device;
  10. struct peci_request;
  11. /* PECI CPU address range 0x30-0x37 */
  12. #define PECI_BASE_ADDR 0x30
  13. #define PECI_DEVICE_NUM_MAX 8
  14. struct peci_request *peci_request_alloc(struct peci_device *device, u8 tx_len, u8 rx_len);
  15. void peci_request_free(struct peci_request *req);
  16. int peci_request_status(struct peci_request *req);
  17. u64 peci_request_dib_read(struct peci_request *req);
  18. s16 peci_request_temp_read(struct peci_request *req);
  19. u8 peci_request_data_readb(struct peci_request *req);
  20. u16 peci_request_data_readw(struct peci_request *req);
  21. u32 peci_request_data_readl(struct peci_request *req);
  22. u64 peci_request_data_readq(struct peci_request *req);
  23. struct peci_request *peci_xfer_get_dib(struct peci_device *device);
  24. struct peci_request *peci_xfer_get_temp(struct peci_device *device);
  25. struct peci_request *peci_xfer_pkg_cfg_readb(struct peci_device *device, u8 index, u16 param);
  26. struct peci_request *peci_xfer_pkg_cfg_readw(struct peci_device *device, u8 index, u16 param);
  27. struct peci_request *peci_xfer_pkg_cfg_readl(struct peci_device *device, u8 index, u16 param);
  28. struct peci_request *peci_xfer_pkg_cfg_readq(struct peci_device *device, u8 index, u16 param);
  29. struct peci_request *peci_xfer_pci_cfg_local_readb(struct peci_device *device,
  30. u8 bus, u8 dev, u8 func, u16 reg);
  31. struct peci_request *peci_xfer_pci_cfg_local_readw(struct peci_device *device,
  32. u8 bus, u8 dev, u8 func, u16 reg);
  33. struct peci_request *peci_xfer_pci_cfg_local_readl(struct peci_device *device,
  34. u8 bus, u8 dev, u8 func, u16 reg);
  35. struct peci_request *peci_xfer_ep_pci_cfg_local_readb(struct peci_device *device, u8 seg,
  36. u8 bus, u8 dev, u8 func, u16 reg);
  37. struct peci_request *peci_xfer_ep_pci_cfg_local_readw(struct peci_device *device, u8 seg,
  38. u8 bus, u8 dev, u8 func, u16 reg);
  39. struct peci_request *peci_xfer_ep_pci_cfg_local_readl(struct peci_device *device, u8 seg,
  40. u8 bus, u8 dev, u8 func, u16 reg);
  41. struct peci_request *peci_xfer_ep_pci_cfg_readb(struct peci_device *device, u8 seg,
  42. u8 bus, u8 dev, u8 func, u16 reg);
  43. struct peci_request *peci_xfer_ep_pci_cfg_readw(struct peci_device *device, u8 seg,
  44. u8 bus, u8 dev, u8 func, u16 reg);
  45. struct peci_request *peci_xfer_ep_pci_cfg_readl(struct peci_device *device, u8 seg,
  46. u8 bus, u8 dev, u8 func, u16 reg);
  47. struct peci_request *peci_xfer_ep_mmio32_readl(struct peci_device *device, u8 bar, u8 seg,
  48. u8 bus, u8 dev, u8 func, u64 offset);
  49. struct peci_request *peci_xfer_ep_mmio64_readl(struct peci_device *device, u8 bar, u8 seg,
  50. u8 bus, u8 dev, u8 func, u64 offset);
  51. /**
  52. * struct peci_device_id - PECI device data to match
  53. * @data: pointer to driver private data specific to device
  54. * @family: device family
  55. * @model: device model
  56. */
  57. struct peci_device_id {
  58. const void *data;
  59. u16 family;
  60. u8 model;
  61. };
  62. extern struct device_type peci_device_type;
  63. extern const struct attribute_group *peci_device_groups[];
  64. int peci_device_create(struct peci_controller *controller, u8 addr);
  65. void peci_device_destroy(struct peci_device *device);
  66. extern struct bus_type peci_bus_type;
  67. extern const struct attribute_group *peci_bus_groups[];
  68. /**
  69. * struct peci_driver - PECI driver
  70. * @driver: inherit device driver
  71. * @probe: probe callback
  72. * @remove: remove callback
  73. * @id_table: PECI device match table to decide which device to bind
  74. */
  75. struct peci_driver {
  76. struct device_driver driver;
  77. int (*probe)(struct peci_device *device, const struct peci_device_id *id);
  78. void (*remove)(struct peci_device *device);
  79. const struct peci_device_id *id_table;
  80. };
  81. static inline struct peci_driver *to_peci_driver(struct device_driver *d)
  82. {
  83. return container_of(d, struct peci_driver, driver);
  84. }
  85. int __peci_driver_register(struct peci_driver *driver, struct module *owner,
  86. const char *mod_name);
  87. /**
  88. * peci_driver_register() - register PECI driver
  89. * @driver: the driver to be registered
  90. *
  91. * PECI drivers that don't need to do anything special in module init should
  92. * use the convenience "module_peci_driver" macro instead
  93. *
  94. * Return: zero on success, else a negative error code.
  95. */
  96. #define peci_driver_register(driver) \
  97. __peci_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
  98. void peci_driver_unregister(struct peci_driver *driver);
  99. /**
  100. * module_peci_driver() - helper macro for registering a modular PECI driver
  101. * @__peci_driver: peci_driver struct
  102. *
  103. * Helper macro for PECI drivers which do not do anything special in module
  104. * init/exit. This eliminates a lot of boilerplate. Each module may only
  105. * use this macro once, and calling it replaces module_init() and module_exit()
  106. */
  107. #define module_peci_driver(__peci_driver) \
  108. module_driver(__peci_driver, peci_driver_register, peci_driver_unregister)
  109. extern struct device_type peci_controller_type;
  110. int peci_controller_scan_devices(struct peci_controller *controller);
  111. #endif /* __PECI_INTERNAL_H */