misc/mei/hw.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * Copyright (c) 2003-2022, Intel Corporation. All rights reserved
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)
259  * struct mei_ext_meta_hdr - extend header meta data
273  * struct mei_ext_hdr_vtag - extend header for vtag
289  * mei_ext_begin - extended header iterator begin
297 	return (struct mei_ext_hdr *)meta->hdrs;  in mei_ext_begin()
301  * mei_ext_last - check if the ext is the last one in the TLV list
304  * @ext: a meta header on the list
306  * Return: true if ext is the last header on the list
309 				struct mei_ext_hdr *ext)  in mei_ext_last()  argument
311 	return (u8 *)ext >= (u8 *)meta + sizeof(*meta) + (meta->size * 4);  in mei_ext_last()
325 #define GSC_ADDRESS_TYPE_PHYSICAL_CONTINUOUS 2 /* max of 64K */
329  * struct mei_ext_hdr_gsc_h2f - extended header: gsc host to firmware interface
352  * struct mei_ext_hdr_gsc_f2h - gsc firmware to host interface
369  * mei_ext_next - following extended header on the TLV list
371  * @ext: current extend header
376  * Return: The following extend header after @ext
378 static inline struct mei_ext_hdr *mei_ext_next(struct mei_ext_hdr *ext)  in mei_ext_next()  argument
380 	return (struct mei_ext_hdr *)((u8 *)ext + (ext->length * 4));  in mei_ext_next()
384  * mei_ext_hdr_len - get ext header length in bytes
386  * @ext: extend header
390 static inline u32 mei_ext_hdr_len(const struct mei_ext_hdr *ext)  in mei_ext_hdr_len()  argument
392 	if (!ext)  in mei_ext_hdr_len()
395 	return ext->length * sizeof(u32);  in mei_ext_hdr_len()
399  * struct mei_msg_hdr - MEI BUS Interface Section
432  * struct hbm_cl_cmd - client specific host bus command
482  * enum hbm_host_enum_flags - enumeration request flags (HBM version >= 2.0)
493  * struct hbm_host_enum_request - enumeration request from host to fw
508 	u8 valid_addresses[32];
512  * struct mei_client_properties - mei client properties
549  * struct hbm_add_client_request - request to add a client
565  * struct hbm_add_client_response - response to add a client
581  * struct hbm_power_gate - power gate request/response
592  * struct hbm_client_connect_request - connect/disconnect request
607  * struct hbm_client_connect_response - connect/disconnect response
634  * struct hbm_notification_request - start/stop notification request
649  * struct hbm_notification_response - start/stop notification response
653  * @host_addr: - address of the client in the driver
655  *  - MEI_HBMS_SUCCESS: successful stop/start
656  *  - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
657  *  - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
659  *  - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
675  * struct hbm_notification - notification event
690  * struct hbm_dma_mem_dscr - dma ring
692  * @addr_hi: the high 32bits of 64 bit address
693  * @addr_lo: the low  32bits of 64 bit address
710  * struct hbm_dma_setup_request - dma setup request
723  * struct hbm_dma_setup_response - dma setup response
736  * struct mei_dma_ring_ctrl - dma ring control block
768  * struct hbm_capability_request - capability request from host to fw
779  * struct hbm_capability_response - capability response from fw to host
790  * struct hbm_client_dma_map_request - client dma map request from host to fw