misc/mei/hw.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * Copyright (c) 2003-2022, Intel Corporation. All rights reserved
113 /* Host bus message command opcode */
115 /* Host bus message command RESPONSE */
119  * MEI Bus Message Command IDs
185  * enum mei_hbm_status  - mei host bus messages return values
233  * enum mei_ext_hdr_type - extended header type used in
247  * struct mei_ext_hdr - extend header descriptor (TLV)
257  * struct mei_ext_meta_hdr - extend header meta data
271  * struct mei_ext_hdr_vtag - extend header for vtag
287  * mei_ext_begin - extended header iterator begin
295 	return (struct mei_ext_hdr *)meta->hdrs;  in mei_ext_begin()
299  * mei_ext_last - check if the ext is the last one in the TLV list
309 	return (u8 *)ext >= (u8 *)meta + sizeof(*meta) + (meta->size * 4);  in mei_ext_last()
327  * struct mei_ext_hdr_gsc_h2f - extended header: gsc host to firmware interface
350  * struct mei_ext_hdr_gsc_f2h - gsc firmware to host interface
367  * mei_ext_next - following extended header on the TLV list
378 	return (struct mei_ext_hdr *)((u8 *)ext + (ext->length * 4));  in mei_ext_next()
382  * mei_ext_hdr_len - get ext header length in bytes
393 	return ext->length * sizeof(u32);  in mei_ext_hdr_len()
397  * struct mei_msg_hdr - MEI BUS Interface Section
400  * @host_addr: host address
430  * struct mei_hbm_cl_cmd - client specific host bus command
433  * @hbm_cmd: bus message command header
480  * enum hbm_host_enum_flags - enumeration request flags (HBM version >= 2.0)
491  * struct hbm_host_enum_request - enumeration request from host to fw
493  * @hbm_cmd : bus message command header
510  * struct mei_client_properties - mei client properties
547  * struct hbm_add_client_request - request to add a client
550  * @hbm_cmd: bus message command header
563  * struct hbm_add_client_response - response to add a client
564  *     sent by the host to report client addition status to fw
566  * @hbm_cmd: bus message command header
579  * struct hbm_power_gate - power gate request/response
581  * @hbm_cmd: bus message command header
590  * struct hbm_client_connect_request - connect/disconnect request
592  * @hbm_cmd: bus message command header
605  * struct hbm_client_connect_response - connect/disconnect response
607  * @hbm_cmd: bus message command header
632  * struct hbm_notification_request - start/stop notification request
634  * @hbm_cmd: bus message command header
647  * struct hbm_notification_response - start/stop notification response
649  * @hbm_cmd: bus message command header
651  * @host_addr: - address of the client in the driver
653  *  - MEI_HBMS_SUCCESS: successful stop/start
654  *  - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
655  *  - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
657  *  - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
673  * struct hbm_notification - notification event
675  * @hbm_cmd: bus message command header
688  * struct hbm_dma_mem_dscr - dma ring
708  * struct hbm_dma_setup_request - dma setup request
710  * @hbm_cmd: bus message command header
712  * @dma_dscr: dma descriptor for HOST, DEVICE, and CTRL
721  * struct hbm_dma_setup_response - dma setup response
723  * @hbm_cmd: bus message command header
734  * struct hbm_dma_ring_ctrl - dma ring control block
736  * @hbuf_wr_idx: host circular buffer write index in slots
738  * @hbuf_rd_idx: host circular buffer read index in slots
766  * struct hbm_capability_request - capability request from host to fw
768  * @hbm_cmd : bus message command header
769  * @capability_requested: bitmask of capabilities requested by host
777  * struct hbm_capability_response - capability response from fw to host
779  * @hbm_cmd : bus message command header
788  * struct hbm_client_dma_map_request - client dma map request from host to fw
790  * @hbm_cmd: bus message command header
807  * struct hbm_client_dma_unmap_request - client dma unmap request
808  *        from the host to the firmware
810  * @hbm_cmd: bus message command header
823  * struct hbm_client_dma_response - client dma unmap response
824  *        from the firmware to the host
826  * @hbm_cmd: bus message command header
827  * @status: command status