^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (c) 2003-2020, Intel Corporation. All rights reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Intel Management Engine Interface (Intel MEI) Linux driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #ifndef _MEI_HW_TYPES_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #define _MEI_HW_TYPES_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/uuid.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * Timeouts in Seconds
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #define MEI_HW_READY_TIMEOUT 2 /* Timeout on ready message */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #define MEI_CONNECT_TIMEOUT 3 /* HPS: at least 2 seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #define MEI_CL_CONNECT_TIMEOUT 15 /* HPS: Client Connect Timeout */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define MEI_CLIENTS_INIT_TIMEOUT 15 /* HPS: Clients Enumeration Timeout */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define MEI_PGI_TIMEOUT 1 /* PG Isolation time response 1 sec */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define MEI_D0I3_TIMEOUT 5 /* D0i3 set/unset max response time */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define MEI_HBM_TIMEOUT 1 /* 1 second */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * MEI Version
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #define HBM_MINOR_VERSION 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #define HBM_MAJOR_VERSION 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * MEI version with PGI support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) #define HBM_MINOR_VERSION_PGI 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) #define HBM_MAJOR_VERSION_PGI 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) * MEI version with Dynamic clients support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) #define HBM_MINOR_VERSION_DC 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) #define HBM_MAJOR_VERSION_DC 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) * MEI version with immediate reply to enum request support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) #define HBM_MINOR_VERSION_IE 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define HBM_MAJOR_VERSION_IE 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) * MEI version with disconnect on connection timeout support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) #define HBM_MINOR_VERSION_DOT 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) #define HBM_MAJOR_VERSION_DOT 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) * MEI version with notification support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) #define HBM_MINOR_VERSION_EV 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #define HBM_MAJOR_VERSION_EV 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) * MEI version with fixed address client support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) #define HBM_MINOR_VERSION_FA 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) #define HBM_MAJOR_VERSION_FA 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) * MEI version with OS ver message support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) #define HBM_MINOR_VERSION_OS 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) #define HBM_MAJOR_VERSION_OS 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) * MEI version with dma ring support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) #define HBM_MINOR_VERSION_DR 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) #define HBM_MAJOR_VERSION_DR 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) * MEI version with vm tag support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #define HBM_MINOR_VERSION_VT 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) #define HBM_MAJOR_VERSION_VT 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) * MEI version with capabilities message support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) #define HBM_MINOR_VERSION_CAP 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) #define HBM_MAJOR_VERSION_CAP 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) /* Host bus message command opcode */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) #define MEI_HBM_CMD_OP_MSK 0x7f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) /* Host bus message command RESPONSE */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) #define MEI_HBM_CMD_RES_MSK 0x80
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) * MEI Bus Message Command IDs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) #define HOST_START_REQ_CMD 0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) #define HOST_START_RES_CMD 0x81
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) #define HOST_STOP_REQ_CMD 0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) #define HOST_STOP_RES_CMD 0x82
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) #define ME_STOP_REQ_CMD 0x03
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) #define HOST_ENUM_REQ_CMD 0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) #define HOST_ENUM_RES_CMD 0x84
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) #define HOST_CLIENT_PROPERTIES_REQ_CMD 0x05
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) #define HOST_CLIENT_PROPERTIES_RES_CMD 0x85
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) #define CLIENT_CONNECT_REQ_CMD 0x06
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #define CLIENT_CONNECT_RES_CMD 0x86
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) #define CLIENT_DISCONNECT_REQ_CMD 0x07
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) #define CLIENT_DISCONNECT_RES_CMD 0x87
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #define MEI_FLOW_CONTROL_CMD 0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define MEI_PG_ISOLATION_ENTRY_REQ_CMD 0x0a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define MEI_PG_ISOLATION_ENTRY_RES_CMD 0x8a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define MEI_PG_ISOLATION_EXIT_REQ_CMD 0x0b
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) #define MEI_PG_ISOLATION_EXIT_RES_CMD 0x8b
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) #define MEI_HBM_ADD_CLIENT_REQ_CMD 0x0f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) #define MEI_HBM_ADD_CLIENT_RES_CMD 0x8f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) #define MEI_HBM_NOTIFY_REQ_CMD 0x10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) #define MEI_HBM_NOTIFY_RES_CMD 0x90
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) #define MEI_HBM_NOTIFICATION_CMD 0x11
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) #define MEI_HBM_DMA_SETUP_REQ_CMD 0x12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) #define MEI_HBM_DMA_SETUP_RES_CMD 0x92
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) #define MEI_HBM_CAPABILITIES_REQ_CMD 0x13
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) #define MEI_HBM_CAPABILITIES_RES_CMD 0x93
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) * MEI Stop Reason
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) * used by hbm_host_stop_request.reason
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) enum mei_stop_reason_types {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) DRIVER_STOP_REQUEST = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) DEVICE_D1_ENTRY = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) DEVICE_D2_ENTRY = 0x02,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) DEVICE_D3_ENTRY = 0x03,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) SYSTEM_S1_ENTRY = 0x04,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) SYSTEM_S2_ENTRY = 0x05,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) SYSTEM_S3_ENTRY = 0x06,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) SYSTEM_S4_ENTRY = 0x07,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) SYSTEM_S5_ENTRY = 0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) * enum mei_hbm_status - mei host bus messages return values
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) * @MEI_HBMS_SUCCESS : status success
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) * @MEI_HBMS_CLIENT_NOT_FOUND : client not found
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) * @MEI_HBMS_ALREADY_EXISTS : connection already established
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) * @MEI_HBMS_REJECTED : connection is rejected
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) * @MEI_HBMS_INVALID_PARAMETER : invalid parameter
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) * @MEI_HBMS_NOT_ALLOWED : operation not allowed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) * @MEI_HBMS_ALREADY_STARTED : system is already started
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) * @MEI_HBMS_NOT_STARTED : system not started
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) * @MEI_HBMS_MAX : sentinel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) enum mei_hbm_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) MEI_HBMS_SUCCESS = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) MEI_HBMS_CLIENT_NOT_FOUND = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) MEI_HBMS_ALREADY_EXISTS = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) MEI_HBMS_REJECTED = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) MEI_HBMS_INVALID_PARAMETER = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) MEI_HBMS_NOT_ALLOWED = 5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) MEI_HBMS_ALREADY_STARTED = 6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) MEI_HBMS_NOT_STARTED = 7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) MEI_HBMS_MAX
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) * Client Connect Status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) * used by hbm_client_connect_response.status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) enum mei_cl_connect_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) MEI_CL_CONN_SUCCESS = MEI_HBMS_SUCCESS,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) MEI_CL_CONN_NOT_FOUND = MEI_HBMS_CLIENT_NOT_FOUND,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) MEI_CL_CONN_ALREADY_STARTED = MEI_HBMS_ALREADY_EXISTS,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) MEI_CL_CONN_OUT_OF_RESOURCES = MEI_HBMS_REJECTED,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) MEI_CL_CONN_MESSAGE_SMALL = MEI_HBMS_INVALID_PARAMETER,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) MEI_CL_CONN_NOT_ALLOWED = MEI_HBMS_NOT_ALLOWED,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) * Client Disconnect Status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) enum mei_cl_disconnect_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) MEI_CL_DISCONN_SUCCESS = MEI_HBMS_SUCCESS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) * enum mei_ext_hdr_type - extended header type used in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) * extended header TLV
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) * @MEI_EXT_HDR_NONE: sentinel
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) * @MEI_EXT_HDR_VTAG: vtag header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) enum mei_ext_hdr_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) MEI_EXT_HDR_NONE = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) MEI_EXT_HDR_VTAG = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) * struct mei_ext_hdr - extend header descriptor (TLV)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) * @type: enum mei_ext_hdr_type
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) * @length: length excluding descriptor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) * @ext_payload: payload of the specific extended header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) * @hdr: place holder for actual header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) struct mei_ext_hdr {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) u8 type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) u8 length;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) u8 ext_payload[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) u8 hdr[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) * struct mei_ext_meta_hdr - extend header meta data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) * @count: number of headers
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) * @size: total size of the extended header list excluding meta header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) * @hdrs: extended headers TLV list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) struct mei_ext_meta_hdr {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) u8 count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) u8 size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) struct mei_ext_hdr hdrs[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) * Extended header iterator functions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) * mei_ext_hdr - extended header iterator begin
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) * @meta: meta header of the extended header list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) * Return:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) * The first extended header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) static inline struct mei_ext_hdr *mei_ext_begin(struct mei_ext_meta_hdr *meta)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) return meta->hdrs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) * mei_ext_last - check if the ext is the last one in the TLV list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) * @meta: meta header of the extended header list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) * @ext: a meta header on the list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) * Return: true if ext is the last header on the list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) static inline bool mei_ext_last(struct mei_ext_meta_hdr *meta,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) struct mei_ext_hdr *ext)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) return (u8 *)ext >= (u8 *)meta + sizeof(*meta) + (meta->size * 4);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) *mei_ext_next - following extended header on the TLV list
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) * @ext: current extend header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) * Context: The function does not check for the overflows,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) * one should call mei_ext_last before.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) * Return: The following extend header after @ext
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) static inline struct mei_ext_hdr *mei_ext_next(struct mei_ext_hdr *ext)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) return (struct mei_ext_hdr *)(ext->hdr + (ext->length * 4));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) * struct mei_msg_hdr - MEI BUS Interface Section
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) * @me_addr: device address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) * @host_addr: host address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) * @length: message length
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) * @extended: message has extended header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) * @dma_ring: message is on dma ring
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) * @internal: message is internal
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) * @msg_complete: last packet of the message
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) * @extension: extension of the header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) struct mei_msg_hdr {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) u32 me_addr:8;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) u32 host_addr:8;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) u32 length:9;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) u32 reserved:3;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) u32 extended:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) u32 dma_ring:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) u32 internal:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) u32 msg_complete:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) u32 extension[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) /* The length is up to 9 bits */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) #define MEI_MSG_MAX_LEN_MASK GENMASK(9, 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) struct mei_bus_message {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) u8 data[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) * struct hbm_cl_cmd - client specific host bus command
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) * CONNECT, DISCONNECT, and FlOW CONTROL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) * @host_addr: address of the client in the driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) * @data: generic data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) struct mei_hbm_cl_cmd {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) u8 host_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) u8 data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) struct hbm_version {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) u8 minor_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) u8 major_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) struct hbm_host_version_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) u8 reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) struct hbm_version host_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) struct hbm_host_version_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) u8 host_version_supported;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) struct hbm_version me_max_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355) struct hbm_host_stop_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) u8 reason;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358) u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) struct hbm_host_stop_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363) u8 reserved[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) struct hbm_me_stop_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368) u8 reason;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369) u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) * enum hbm_host_enum_flags - enumeration request flags (HBM version >= 2.0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) * @MEI_HBM_ENUM_F_ALLOW_ADD: allow dynamic clients add
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376) * @MEI_HBM_ENUM_F_IMMEDIATE_ENUM: allow FW to send answer immediately
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378) enum hbm_host_enum_flags {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379) MEI_HBM_ENUM_F_ALLOW_ADD = BIT(0),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380) MEI_HBM_ENUM_F_IMMEDIATE_ENUM = BIT(1),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) * struct hbm_host_enum_request - enumeration request from host to fw
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) * @hbm_cmd : bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387) * @flags : request flags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 389) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 390) struct hbm_host_enum_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 391) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 392) u8 flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 393) u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 394) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 395)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 396) struct hbm_host_enum_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 397) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 398) u8 reserved[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 399) u8 valid_addresses[32];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 400) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 401)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 402) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 403) * struct mei_client_properties - mei client properties
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 404) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 405) * @protocol_name: guid of the client
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 406) * @protocol_version: client protocol version
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 407) * @max_number_of_connections: number of possible connections.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 408) * @fixed_address: fixed me address (0 if the client is dynamic)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 409) * @single_recv_buf: 1 if all connections share a single receive buffer.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 410) * @vt_supported: the client support vtag
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 411) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 412) * @max_msg_length: MTU of the client
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 413) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 414) struct mei_client_properties {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 415) uuid_le protocol_name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 416) u8 protocol_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 417) u8 max_number_of_connections;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 418) u8 fixed_address;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 419) u8 single_recv_buf:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 420) u8 vt_supported:1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 421) u8 reserved:6;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 422) u32 max_msg_length;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 423) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 424)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 425) struct hbm_props_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 426) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 427) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 428) u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 429) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 430)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 431) struct hbm_props_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 432) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 433) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 434) u8 status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 435) u8 reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 436) struct mei_client_properties client_properties;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 437) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 438)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 439) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 440) * struct hbm_add_client_request - request to add a client
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 441) * might be sent by fw after enumeration has already completed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 442) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 443) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 444) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 445) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 446) * @client_properties: client properties
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 447) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 448) struct hbm_add_client_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 449) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 450) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 451) u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 452) struct mei_client_properties client_properties;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 453) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 454)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 455) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 456) * struct hbm_add_client_response - response to add a client
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 457) * sent by the host to report client addition status to fw
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 458) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 459) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 460) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 461) * @status: if HBMS_SUCCESS then the client can now accept connections.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 462) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 463) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 464) struct hbm_add_client_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 465) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 466) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 467) u8 status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 468) u8 reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 469) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 470)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 471) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 472) * struct hbm_power_gate - power gate request/response
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 473) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 474) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 475) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 476) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 477) struct hbm_power_gate {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 478) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 479) u8 reserved[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 480) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 481)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 482) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 483) * struct hbm_client_connect_request - connect/disconnect request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 484) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 485) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 486) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 487) * @host_addr: address of the client in the driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 488) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 489) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 490) struct hbm_client_connect_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 491) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 492) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 493) u8 host_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 494) u8 reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 495) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 496)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 497) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 498) * struct hbm_client_connect_response - connect/disconnect response
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 499) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 500) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 501) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 502) * @host_addr: address of the client in the driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 503) * @status: status of the request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 504) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 505) struct hbm_client_connect_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 506) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 507) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 508) u8 host_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 509) u8 status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 510) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 511)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 512)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 513) #define MEI_FC_MESSAGE_RESERVED_LENGTH 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 514)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 515) struct hbm_flow_control {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 516) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 517) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 518) u8 host_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 519) u8 reserved[MEI_FC_MESSAGE_RESERVED_LENGTH];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 520) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 521)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 522) #define MEI_HBM_NOTIFICATION_START 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 523) #define MEI_HBM_NOTIFICATION_STOP 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 524) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 525) * struct hbm_notification_request - start/stop notification request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 526) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 527) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 528) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 529) * @host_addr: address of the client in the driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 530) * @start: start = 1 or stop = 0 asynchronous notifications
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 531) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 532) struct hbm_notification_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 533) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 534) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 535) u8 host_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 536) u8 start;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 537) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 538)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 539) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 540) * struct hbm_notification_response - start/stop notification response
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 541) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 542) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 543) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 544) * @host_addr: - address of the client in the driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 545) * @status: (mei_hbm_status) response status for the request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 546) * - MEI_HBMS_SUCCESS: successful stop/start
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 547) * - MEI_HBMS_CLIENT_NOT_FOUND: if the connection could not be found.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 548) * - MEI_HBMS_ALREADY_STARTED: for start requests for a previously
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 549) * started notification.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 550) * - MEI_HBMS_NOT_STARTED: for stop request for a connected client for whom
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 551) * asynchronous notifications are currently disabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 552) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 553) * @start: start = 1 or stop = 0 asynchronous notifications
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 554) * @reserved: reserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 555) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 556) struct hbm_notification_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 557) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 558) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 559) u8 host_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 560) u8 status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 561) u8 start;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 562) u8 reserved[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 563) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 564)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 565) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 566) * struct hbm_notification - notification event
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 567) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 568) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 569) * @me_addr: address of the client in ME
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 570) * @host_addr: address of the client in the driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 571) * @reserved: reserved for alignment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 572) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 573) struct hbm_notification {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 574) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 575) u8 me_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 576) u8 host_addr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 577) u8 reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 578) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 579)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 580) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 581) * struct hbm_dma_mem_dscr - dma ring
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 582) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 583) * @addr_hi: the high 32bits of 64 bit address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 584) * @addr_lo: the low 32bits of 64 bit address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 585) * @size : size in bytes (must be power of 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 586) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 587) struct hbm_dma_mem_dscr {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 588) u32 addr_hi;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 589) u32 addr_lo;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 590) u32 size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 591) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 592)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 593) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 594) DMA_DSCR_HOST = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 595) DMA_DSCR_DEVICE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 596) DMA_DSCR_CTRL = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 597) DMA_DSCR_NUM,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 598) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 599)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 600) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 601) * struct hbm_dma_setup_request - dma setup request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 602) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 603) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 604) * @reserved: reserved for alignment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 605) * @dma_dscr: dma descriptor for HOST, DEVICE, and CTRL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 606) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 607) struct hbm_dma_setup_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 608) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 609) u8 reserved[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 610) struct hbm_dma_mem_dscr dma_dscr[DMA_DSCR_NUM];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 611) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 612)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 613) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 614) * struct hbm_dma_setup_response - dma setup response
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 615) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 616) * @hbm_cmd: bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 617) * @status: 0 on success; otherwise DMA setup failed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 618) * @reserved: reserved for alignment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 619) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 620) struct hbm_dma_setup_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 621) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 622) u8 status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 623) u8 reserved[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 624) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 625)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 626) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 627) * struct mei_dma_ring_ctrl - dma ring control block
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 628) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 629) * @hbuf_wr_idx: host circular buffer write index in slots
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 630) * @reserved1: reserved for alignment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 631) * @hbuf_rd_idx: host circular buffer read index in slots
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 632) * @reserved2: reserved for alignment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 633) * @dbuf_wr_idx: device circular buffer write index in slots
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 634) * @reserved3: reserved for alignment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 635) * @dbuf_rd_idx: device circular buffer read index in slots
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 636) * @reserved4: reserved for alignment
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 637) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 638) struct hbm_dma_ring_ctrl {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 639) u32 hbuf_wr_idx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 640) u32 reserved1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 641) u32 hbuf_rd_idx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 642) u32 reserved2;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 643) u32 dbuf_wr_idx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 644) u32 reserved3;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 645) u32 dbuf_rd_idx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 646) u32 reserved4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 647) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 648)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 649) /* virtual tag supported */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 650) #define HBM_CAP_VT BIT(0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 651)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 652) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 653) * struct hbm_capability_request - capability request from host to fw
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 654) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 655) * @hbm_cmd : bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 656) * @capability_requested: bitmask of capabilities requested by host
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 657) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 658) struct hbm_capability_request {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 659) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 660) u8 capability_requested[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 661) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 662)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 663) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 664) * struct hbm_capability_response - capability response from fw to host
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 665) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 666) * @hbm_cmd : bus message command header
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 667) * @capability_granted: bitmask of capabilities granted by FW
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 668) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 669) struct hbm_capability_response {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 670) u8 hbm_cmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 671) u8 capability_granted[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 672) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 673)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 674) #endif
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags