/* SPDX-License-Identifier: GPL-2.0 */ /* * Copyright (c) 2003-2022, Intel Corporation. All rights reserved. * Intel Management Engine Interface (Intel MEI) Linux driver */ #ifndef _MEI_DEV_H_ #define _MEI_DEV_H_ #include <linux/types.h> #include <linux/cdev.h> #include <linux/poll.h> #include <linux/mei.h> #include <linux/mei_cl_bus.h> static inline int uuid_le_cmp(const uuid_le u1, const uuid_le u2) { … } #include "hw.h" #include "hbm.h" #define MEI_SLOT_SIZE … #define MEI_RD_MSG_BUF_SIZE … /* * Number of Maximum MEI Clients */ #define MEI_CLIENTS_MAX … /* * maximum number of consecutive resets */ #define MEI_MAX_CONSEC_RESET … /* * Number of File descriptors/handles * that can be opened to the driver. * * Limit to 255: 256 Total Clients * minus internal client for MEI Bus Messages */ #define MEI_MAX_OPEN_HANDLE_COUNT … /* File state */ enum file_state { … }; /* MEI device states */ enum mei_dev_state { … }; /** * enum mei_dev_pxp_mode - MEI PXP mode state * * @MEI_DEV_PXP_DEFAULT: PCH based device, no initialization required * @MEI_DEV_PXP_INIT: device requires initialization, send setup message to firmware * @MEI_DEV_PXP_SETUP: device is in setup stage, waiting for firmware response * @MEI_DEV_PXP_READY: device initialized */ enum mei_dev_pxp_mode { … }; /** * enum mei_dev_reset_to_pxp - reset to PXP mode performed * * @MEI_DEV_RESET_TO_PXP_DEFAULT: before reset * @MEI_DEV_RESET_TO_PXP_PERFORMED: reset performed * @MEI_DEV_RESET_TO_PXP_DONE: reset processed */ enum mei_dev_reset_to_pxp { … }; const char *mei_dev_state_str(int state); enum mei_file_transaction_states { … }; /** * enum mei_cb_file_ops - file operation associated with the callback * @MEI_FOP_READ: read * @MEI_FOP_WRITE: write * @MEI_FOP_CONNECT: connect * @MEI_FOP_DISCONNECT: disconnect * @MEI_FOP_DISCONNECT_RSP: disconnect response * @MEI_FOP_NOTIFY_START: start notification * @MEI_FOP_NOTIFY_STOP: stop notification * @MEI_FOP_DMA_MAP: request client dma map * @MEI_FOP_DMA_UNMAP: request client dma unmap */ enum mei_cb_file_ops { … }; /** * enum mei_cl_io_mode - io mode between driver and fw * * @MEI_CL_IO_TX_BLOCKING: send is blocking * @MEI_CL_IO_TX_INTERNAL: internal communication between driver and FW * * @MEI_CL_IO_RX_NONBLOCK: recv is non-blocking * * @MEI_CL_IO_SGL: send command with sgl list. */ enum mei_cl_io_mode { … }; /* * Intel MEI message data struct */ struct mei_msg_data { … }; struct mei_dma_data { … }; /** * struct mei_dma_dscr - dma address descriptor * * @vaddr: dma buffer virtual address * @daddr: dma buffer physical address * @size : dma buffer size */ struct mei_dma_dscr { … }; /* Maximum number of processed FW status registers */ #define MEI_FW_STATUS_MAX … /* Minimal buffer for FW status string (8 bytes in dw + space or '\0') */ #define MEI_FW_STATUS_STR_SZ … /* * struct mei_fw_status - storage of FW status data * * @count: number of actually available elements in array * @status: FW status registers */ struct mei_fw_status { … }; /** * struct mei_me_client - representation of me (fw) client * * @list: link in me client list * @refcnt: struct reference count * @props: client properties * @client_id: me client id * @tx_flow_ctrl_creds: flow control credits * @connect_count: number connections to this client * @bus_added: added to bus */ struct mei_me_client { … }; struct mei_cl; /** * struct mei_cl_cb - file operation callback structure * * @list: link in callback queue * @cl: file client who is running this operation * @fop_type: file operation type * @buf: buffer for data associated with the callback * @buf_idx: last read index * @vtag: virtual tag * @fp: pointer to file structure * @status: io status of the cb * @internal: communication between driver and FW flag * @blocking: transmission blocking mode * @ext_hdr: extended header */ struct mei_cl_cb { … }; /** * struct mei_cl_vtag - file pointer to vtag mapping structure * * @list: link in map queue * @fp: file pointer * @vtag: corresponding vtag * @pending_read: the read is pending on this file */ struct mei_cl_vtag { … }; /** * struct mei_cl - me client host representation * carried in file->private_data * * @link: link in the clients list * @dev: mei parent device * @state: file operation state * @tx_wait: wait queue for tx completion * @rx_wait: wait queue for rx completion * @wait: wait queue for management operation * @ev_wait: notification wait queue * @ev_async: event async notification * @status: connection status * @me_cl: fw client connected * @fp: file associated with client * @host_client_id: host id * @vtag_map: vtag map * @tx_flow_ctrl_creds: transmit flow credentials * @rx_flow_ctrl_creds: receive flow credentials * @timer_count: watchdog timer for operation completion * @notify_en: notification - enabled/disabled * @notify_ev: pending notification event * @tx_cb_queued: number of tx callbacks in queue * @writing_state: state of the tx * @rd_pending: pending read credits * @rd_completed_lock: protects rd_completed queue * @rd_completed: completed read * @dma: dma settings * @dma_mapped: dma buffer is currently mapped. * * @cldev: device on the mei client bus */ struct mei_cl { … }; #define MEI_TX_QUEUE_LIMIT_DEFAULT … #define MEI_TX_QUEUE_LIMIT_MAX … #define MEI_TX_QUEUE_LIMIT_MIN … /** * struct mei_hw_ops - hw specific ops * * @host_is_ready : query for host readiness * * @hw_is_ready : query if hw is ready * @hw_reset : reset hw * @hw_start : start hw after reset * @hw_config : configure hw * * @fw_status : get fw status registers * @trc_status : get trc status register * @pg_state : power gating state of the device * @pg_in_transition : is device now in pg transition * @pg_is_enabled : is power gating enabled * * @intr_clear : clear pending interrupts * @intr_enable : enable interrupts * @intr_disable : disable interrupts * @synchronize_irq : synchronize irqs * * @hbuf_free_slots : query for write buffer empty slots * @hbuf_is_ready : query if write buffer is empty * @hbuf_depth : query for write buffer depth * * @write : write a message to FW * * @rdbuf_full_slots : query how many slots are filled * * @read_hdr : get first 4 bytes (header) * @read : read a buffer from the FW */ struct mei_hw_ops { … }; /* MEI bus API*/ void mei_cl_bus_rescan_work(struct work_struct *work); void mei_cl_bus_dev_fixup(struct mei_cl_device *dev); ssize_t __mei_cl_send(struct mei_cl *cl, const u8 *buf, size_t length, u8 vtag, unsigned int mode); ssize_t __mei_cl_send_timeout(struct mei_cl *cl, const u8 *buf, size_t length, u8 vtag, unsigned int mode, unsigned long timeout); ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length, u8 *vtag, unsigned int mode, unsigned long timeout); bool mei_cl_bus_rx_event(struct mei_cl *cl); bool mei_cl_bus_notify_event(struct mei_cl *cl); void mei_cl_bus_remove_devices(struct mei_device *bus); int mei_cl_bus_init(void); void mei_cl_bus_exit(void); /** * enum mei_pg_event - power gating transition events * * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete * @MEI_PG_EVENT_RECEIVED: the driver received pg event * @MEI_PG_EVENT_INTR_WAIT: the driver is waiting for a pg event interrupt * @MEI_PG_EVENT_INTR_RECEIVED: the driver received pg event interrupt */ enum mei_pg_event { … }; /** * enum mei_pg_state - device internal power gating state * * @MEI_PG_OFF: device is not power gated - it is active * @MEI_PG_ON: device is power gated - it is in lower power state */ enum mei_pg_state { … }; const char *mei_pg_state_str(enum mei_pg_state state); /** * struct mei_fw_version - MEI FW version struct * * @platform: platform identifier * @major: major version field * @minor: minor version field * @buildno: build number version field * @hotfix: hotfix number version field */ struct mei_fw_version { … }; #define MEI_MAX_FW_VER_BLOCKS … struct mei_dev_timeouts { … }; /** * struct mei_device - MEI private device struct * * @dev : device on a bus * @cdev : character device * @minor : minor number allocated for device * * @write_list : write pending list * @write_waiting_list : write completion list * @ctrl_wr_list : pending control write list * @ctrl_rd_list : pending control read list * @tx_queue_limit: tx queues per client linit * * @file_list : list of opened handles * @open_handle_count: number of opened handles * * @device_lock : big device lock * @timer_work : MEI timer delayed work (timeouts) * * @recvd_hw_ready : hw ready message received flag * * @wait_hw_ready : wait queue for receive HW ready message form FW * @wait_pg : wait queue for receive PG message from FW * @wait_hbm_start : wait queue for receive HBM start message from FW * * @reset_count : number of consecutive resets * @dev_state : device state * @hbm_state : state of host bus message protocol * @pxp_mode : PXP device mode * @init_clients_timer : HBM init handshake timeout * * @pg_event : power gating event * @pg_domain : runtime PM domain * * @rd_msg_buf : control messages buffer * @rd_msg_hdr : read message header storage * @rd_msg_hdr_count : how many dwords were already read from header * * @hbuf_is_ready : query if the host host/write buffer is ready * @dr_dscr: DMA ring descriptors: TX, RX, and CTRL * * @version : HBM protocol version in use * @hbm_f_pg_supported : hbm feature pgi protocol * @hbm_f_dc_supported : hbm feature dynamic clients * @hbm_f_dot_supported : hbm feature disconnect on timeout * @hbm_f_ev_supported : hbm feature event notification * @hbm_f_fa_supported : hbm feature fixed address client * @hbm_f_ie_supported : hbm feature immediate reply to enum request * @hbm_f_os_supported : hbm feature support OS ver message * @hbm_f_dr_supported : hbm feature dma ring supported * @hbm_f_vt_supported : hbm feature vtag supported * @hbm_f_cap_supported : hbm feature capabilities message supported * @hbm_f_cd_supported : hbm feature client dma supported * @hbm_f_gsc_supported : hbm feature gsc supported * * @fw_ver : FW versions * * @fw_f_fw_ver_supported : fw feature: fw version supported * @fw_ver_received : fw version received * * @me_clients_rwsem: rw lock over me_clients list * @me_clients : list of FW clients * @me_clients_map : FW clients bit map * @host_clients_map : host clients id pool * * @allow_fixed_address: allow user space to connect a fixed client * @override_fixed_address: force allow fixed address behavior * * @timeouts: actual timeout values * * @reset_work : work item for the device reset * @bus_rescan_work : work item for the bus rescan * * @device_list : mei client bus list * @cl_bus_lock : client bus list lock * * @kind : kind of mei device * * @dbgfs_dir : debugfs mei root directory * * @saved_fw_status : saved firmware status * @saved_dev_state : saved device state * @saved_fw_status_flag : flag indicating that firmware status was saved * @gsc_reset_to_pxp : state of reset to the PXP mode * * @ops: : hw specific operations * @hw : hw specific data */ struct mei_device { … }; static inline unsigned long mei_secs_to_jiffies(unsigned long sec) { … } /** * mei_data2slots - get slots number from a message length * * @length: size of the messages in bytes * * Return: number of slots */ static inline u32 mei_data2slots(size_t length) { … } /** * mei_hbm2slots - get slots number from a hbm message length * length + size of the mei message header * * @length: size of the messages in bytes * * Return: number of slots */ static inline u32 mei_hbm2slots(size_t length) { … } /** * mei_slots2data - get data in slots - bytes from slots * * @slots: number of available slots * * Return: number of bytes in slots */ static inline u32 mei_slots2data(int slots) { … } /* * mei init function prototypes */ void mei_device_init(struct mei_device *dev, struct device *device, bool slow_fw, const struct mei_hw_ops *hw_ops); int mei_reset(struct mei_device *dev); int mei_start(struct mei_device *dev); int mei_restart(struct mei_device *dev); void mei_stop(struct mei_device *dev); void mei_cancel_work(struct mei_device *dev); void mei_set_devstate(struct mei_device *dev, enum mei_dev_state state); int mei_dmam_ring_alloc(struct mei_device *dev); void mei_dmam_ring_free(struct mei_device *dev); bool mei_dma_ring_is_allocated(struct mei_device *dev); void mei_dma_ring_reset(struct mei_device *dev); void mei_dma_ring_read(struct mei_device *dev, unsigned char *buf, u32 len); void mei_dma_ring_write(struct mei_device *dev, unsigned char *buf, u32 len); u32 mei_dma_ring_empty_slots(struct mei_device *dev); /* * MEI interrupt functions prototype */ void mei_timer(struct work_struct *work); void mei_schedule_stall_timer(struct mei_device *dev); int mei_irq_read_handler(struct mei_device *dev, struct list_head *cmpl_list, s32 *slots); int mei_irq_write_handler(struct mei_device *dev, struct list_head *cmpl_list); void mei_irq_compl_handler(struct mei_device *dev, struct list_head *cmpl_list); /* * Register Access Function */ static inline int mei_hw_config(struct mei_device *dev) { … } static inline enum mei_pg_state mei_pg_state(struct mei_device *dev) { … } static inline bool mei_pg_in_transition(struct mei_device *dev) { … } static inline bool mei_pg_is_enabled(struct mei_device *dev) { … } static inline int mei_hw_reset(struct mei_device *dev, bool enable) { … } static inline int mei_hw_start(struct mei_device *dev) { … } static inline void mei_clear_interrupts(struct mei_device *dev) { … } static inline void mei_enable_interrupts(struct mei_device *dev) { … } static inline void mei_disable_interrupts(struct mei_device *dev) { … } static inline void mei_synchronize_irq(struct mei_device *dev) { … } static inline bool mei_host_is_ready(struct mei_device *dev) { … } static inline bool mei_hw_is_ready(struct mei_device *dev) { … } static inline bool mei_hbuf_is_ready(struct mei_device *dev) { … } static inline int mei_hbuf_empty_slots(struct mei_device *dev) { … } static inline u32 mei_hbuf_depth(const struct mei_device *dev) { … } static inline int mei_write_message(struct mei_device *dev, const void *hdr, size_t hdr_len, const void *data, size_t data_len) { … } static inline u32 mei_read_hdr(const struct mei_device *dev) { … } static inline void mei_read_slots(struct mei_device *dev, unsigned char *buf, unsigned long len) { … } static inline int mei_count_full_read_slots(struct mei_device *dev) { … } static inline int mei_trc_status(struct mei_device *dev, u32 *trc) { … } static inline int mei_fw_status(struct mei_device *dev, struct mei_fw_status *fw_status) { … } bool mei_hbuf_acquire(struct mei_device *dev); bool mei_write_is_idle(struct mei_device *dev); #if IS_ENABLED(CONFIG_DEBUG_FS) void mei_dbgfs_register(struct mei_device *dev, const char *name); void mei_dbgfs_deregister(struct mei_device *dev); #else static inline void mei_dbgfs_register(struct mei_device *dev, const char *name) {} static inline void mei_dbgfs_deregister(struct mei_device *dev) {} #endif /* CONFIG_DEBUG_FS */ int mei_register(struct mei_device *dev, struct device *parent); void mei_deregister(struct mei_device *dev); #define MEI_HDR_FMT … #define MEI_HDR_PRM(hdr) … ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len); /** * mei_fw_status_str - fetch and convert fw status registers to printable string * * @dev: the device structure * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ * * Return: number of bytes written or < 0 on failure */ static inline ssize_t mei_fw_status_str(struct mei_device *dev, char *buf, size_t len) { … } /** * kind_is_gsc - checks whether the device is gsc * * @dev: the device structure * * Return: whether the device is gsc */ static inline bool kind_is_gsc(struct mei_device *dev) { … } /** * kind_is_gscfi - checks whether the device is gscfi * * @dev: the device structure * * Return: whether the device is gscfi */ static inline bool kind_is_gscfi(struct mei_device *dev) { … } #endif
Codebase Browser
linux