drivers/peci/internal.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /* Copyright (c) 2018-2021 Intel Corporation */
0003
0004 #ifndef __PECI_INTERNAL_H
0005 #define __PECI_INTERNAL_H
0006
0007 #include <linux/device.h>
0008 #include <linux/types.h>
0009
0010 struct peci_controller;
0011 struct attribute_group;
0012 struct peci_device;
0013 struct peci_request;
0014
0015 /* PECI CPU address range 0x30-0x37 */
0016 #define PECI_BASE_ADDR      0x30
0017 #define PECI_DEVICE_NUM_MAX 8
0018
0019 struct peci_request *peci_request_alloc(struct peci_device *device, u8 tx_len, u8 rx_len);
0020 void peci_request_free(struct peci_request *req);
0021
0022 int peci_request_status(struct peci_request *req);
0023
0024 u64 peci_request_dib_read(struct peci_request *req);
0025 s16 peci_request_temp_read(struct peci_request *req);
0026
0027 u8 peci_request_data_readb(struct peci_request *req);
0028 u16 peci_request_data_readw(struct peci_request *req);
0029 u32 peci_request_data_readl(struct peci_request *req);
0030 u64 peci_request_data_readq(struct peci_request *req);
0031
0032 struct peci_request *peci_xfer_get_dib(struct peci_device *device);
0033 struct peci_request *peci_xfer_get_temp(struct peci_device *device);
0034
0035 struct peci_request *peci_xfer_pkg_cfg_readb(struct peci_device *device, u8 index, u16 param);
0036 struct peci_request *peci_xfer_pkg_cfg_readw(struct peci_device *device, u8 index, u16 param);
0037 struct peci_request *peci_xfer_pkg_cfg_readl(struct peci_device *device, u8 index, u16 param);
0038 struct peci_request *peci_xfer_pkg_cfg_readq(struct peci_device *device, u8 index, u16 param);
0039
0040 struct peci_request *peci_xfer_pci_cfg_local_readb(struct peci_device *device,
0041                            u8 bus, u8 dev, u8 func, u16 reg);
0042 struct peci_request *peci_xfer_pci_cfg_local_readw(struct peci_device *device,
0043                            u8 bus, u8 dev, u8 func, u16 reg);
0044 struct peci_request *peci_xfer_pci_cfg_local_readl(struct peci_device *device,
0045                            u8 bus, u8 dev, u8 func, u16 reg);
0046
0047 struct peci_request *peci_xfer_ep_pci_cfg_local_readb(struct peci_device *device, u8 seg,
0048                               u8 bus, u8 dev, u8 func, u16 reg);
0049 struct peci_request *peci_xfer_ep_pci_cfg_local_readw(struct peci_device *device, u8 seg,
0050                               u8 bus, u8 dev, u8 func, u16 reg);
0051 struct peci_request *peci_xfer_ep_pci_cfg_local_readl(struct peci_device *device, u8 seg,
0052                               u8 bus, u8 dev, u8 func, u16 reg);
0053
0054 struct peci_request *peci_xfer_ep_pci_cfg_readb(struct peci_device *device, u8 seg,
0055                         u8 bus, u8 dev, u8 func, u16 reg);
0056 struct peci_request *peci_xfer_ep_pci_cfg_readw(struct peci_device *device, u8 seg,
0057                         u8 bus, u8 dev, u8 func, u16 reg);
0058 struct peci_request *peci_xfer_ep_pci_cfg_readl(struct peci_device *device, u8 seg,
0059                         u8 bus, u8 dev, u8 func, u16 reg);
0060
0061 struct peci_request *peci_xfer_ep_mmio32_readl(struct peci_device *device, u8 bar, u8 seg,
0062                            u8 bus, u8 dev, u8 func, u64 offset);
0063
0064 struct peci_request *peci_xfer_ep_mmio64_readl(struct peci_device *device, u8 bar, u8 seg,
0065                            u8 bus, u8 dev, u8 func, u64 offset);
0066 /**
0067  * struct peci_device_id - PECI device data to match
0068  * @data: pointer to driver private data specific to device
0069  * @family: device family
0070  * @model: device model
0071  */
0072 struct peci_device_id {
0073     const void *data;
0074     u16 family;
0075     u8 model;
0076 };
0077
0078 extern struct device_type peci_device_type;
0079 extern const struct attribute_group *peci_device_groups[];
0080
0081 int peci_device_create(struct peci_controller *controller, u8 addr);
0082 void peci_device_destroy(struct peci_device *device);
0083
0084 extern struct bus_type peci_bus_type;
0085 extern const struct attribute_group *peci_bus_groups[];
0086
0087 /**
0088  * struct peci_driver - PECI driver
0089  * @driver: inherit device driver
0090  * @probe: probe callback
0091  * @remove: remove callback
0092  * @id_table: PECI device match table to decide which device to bind
0093  */
0094 struct peci_driver {
0095     struct device_driver driver;
0096     int (*probe)(struct peci_device *device, const struct peci_device_id *id);
0097     void (*remove)(struct peci_device *device);
0098     const struct peci_device_id *id_table;
0099 };
0100
0101 static inline struct peci_driver *to_peci_driver(struct device_driver *d)
0102 {
0103     return container_of(d, struct peci_driver, driver);
0104 }
0105
0106 int __peci_driver_register(struct peci_driver *driver, struct module *owner,
0107                const char *mod_name);
0108 /**
0109  * peci_driver_register() - register PECI driver
0110  * @driver: the driver to be registered
0111  *
0112  * PECI drivers that don't need to do anything special in module init should
0113  * use the convenience "module_peci_driver" macro instead
0114  *
0115  * Return: zero on success, else a negative error code.
0116  */
0117 #define peci_driver_register(driver) \
0118     __peci_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
0119 void peci_driver_unregister(struct peci_driver *driver);
0120
0121 /**
0122  * module_peci_driver() - helper macro for registering a modular PECI driver
0123  * @__peci_driver: peci_driver struct
0124  *
0125  * Helper macro for PECI drivers which do not do anything special in module
0126  * init/exit. This eliminates a lot of boilerplate. Each module may only
0127  * use this macro once, and calling it replaces module_init() and module_exit()
0128  */
0129 #define module_peci_driver(__peci_driver) \
0130     module_driver(__peci_driver, peci_driver_register, peci_driver_unregister)
0131
0132 extern struct device_type peci_controller_type;
0133
0134 int peci_controller_scan_devices(struct peci_controller *controller);
0135
0136 #endif /* __PECI_INTERNAL_H */