^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright 2016 Broadcom
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) */
^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) * This file contains SPU message definitions specific to SPU-M.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #ifndef _SPUM_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #define _SPUM_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #define SPU_CRYPTO_OPERATION_GENERIC 0x1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) /* Length of STATUS field in tx and rx packets */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #define SPU_TX_STATUS_LEN 4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) /* SPU-M error codes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define SPU_STATUS_MASK 0x0000FF00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define SPU_STATUS_SUCCESS 0x00000000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define SPU_STATUS_INVALID_ICV 0x00000100
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define SPU_STATUS_ERROR_FLAG 0x00020000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) /* Request message. MH + EMH + BDESC + BD header */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define SPU_REQ_FIXED_LEN 24
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * Max length of a SPU message header. Used to allocate a buffer where
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * the SPU message header is constructed. Can be used for either a SPU-M
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * header or a SPU2 header.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * For SPU-M, sum of the following:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) * MH - 4 bytes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * EMH - 4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) * SCTX - 3 +
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * max auth key len - 64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) * max cipher key len - 264 (RC4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) * max IV len - 16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) * BDESC - 12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * BD header - 4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * Total: 371
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * For SPU2, FMD_SIZE (32) plus lengths of hash and cipher keys,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) * hash and cipher IVs. If SPU2 does not support RC4, then
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) #define SPU_HEADER_ALLOC_LEN (SPU_REQ_FIXED_LEN + MAX_KEY_SIZE + \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) MAX_KEY_SIZE + MAX_IV_SIZE)
^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) * Response message header length. Normally MH, EMH, BD header, but when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) * BD_SUPPRESS is used for hash requests, there is no BD header.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) #define SPU_RESP_HDR_LEN 12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) #define SPU_HASH_RESP_HDR_LEN 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) * Max value that can be represented in the Payload Length field of the BD
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) * header. This is a 16-bit field.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) #define SPUM_NS2_MAX_PAYLOAD (BIT(16) - 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) * NSP SPU is limited to ~9KB because of FA2 FIFO size limitations;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) * Set MAX_PAYLOAD to 8k to allow for addition of header, digest, etc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) * and stay within limitation.
^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) #define SPUM_NSP_MAX_PAYLOAD 8192
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) /* Buffer Descriptor Header [BDESC]. SPU in big-endian mode. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) struct BDESC_HEADER {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) u16 offset_mac; /* word 0 [31-16] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) u16 length_mac; /* word 0 [15-0] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) u16 offset_crypto; /* word 1 [31-16] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) u16 length_crypto; /* word 1 [15-0] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) u16 offset_icv; /* word 2 [31-16] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) u16 offset_iv; /* word 2 [15-0] */
^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) /* Buffer Data Header [BD]. SPU in big-endian mode. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) struct BD_HEADER {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) u16 size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) u16 prev_length;
^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) /* Command Context Header. SPU-M in big endian mode. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) struct MHEADER {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) u8 flags; /* [31:24] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) u8 op_code; /* [23:16] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) u16 reserved; /* [15:0] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) /* MH header flags bits */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) #define MH_SUPDT_PRES BIT(0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) #define MH_HASH_PRES BIT(2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) #define MH_BD_PRES BIT(3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) #define MH_MFM_PRES BIT(4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) #define MH_BDESC_PRES BIT(5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) #define MH_SCTX_PRES BIT(7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) /* SCTX word 0 bit offsets and fields masks */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) #define SCTX_SIZE 0x000000FF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) /* SCTX word 1 bit shifts and field masks */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) #define UPDT_OFST 0x000000FF /* offset of SCTX updateable fld */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) #define HASH_TYPE 0x00000300 /* hash alg operation type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) #define HASH_TYPE_SHIFT 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) #define HASH_MODE 0x00001C00 /* one of spu2_hash_mode */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) #define HASH_MODE_SHIFT 10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) #define HASH_ALG 0x0000E000 /* hash algorithm */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) #define HASH_ALG_SHIFT 13
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #define CIPHER_TYPE 0x00030000 /* encryption operation type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) #define CIPHER_TYPE_SHIFT 16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #define CIPHER_MODE 0x001C0000 /* encryption mode */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) #define CIPHER_MODE_SHIFT 18
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) #define CIPHER_ALG 0x00E00000 /* encryption algo */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) #define CIPHER_ALG_SHIFT 21
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) #define ICV_IS_512 BIT(27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #define ICV_IS_512_SHIFT 27
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) #define CIPHER_ORDER BIT(30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define CIPHER_ORDER_SHIFT 30
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define CIPHER_INBOUND BIT(31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define CIPHER_INBOUND_SHIFT 31
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) /* SCTX word 2 bit shifts and field masks */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) #define EXP_IV_SIZE 0x7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) #define IV_OFFSET BIT(3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) #define IV_OFFSET_SHIFT 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) #define GEN_IV BIT(5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) #define GEN_IV_SHIFT 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) #define EXPLICIT_IV BIT(6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) #define EXPLICIT_IV_SHIFT 6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) #define SCTX_IV BIT(7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) #define SCTX_IV_SHIFT 7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) #define ICV_SIZE 0x0F00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) #define ICV_SIZE_SHIFT 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) #define CHECK_ICV BIT(12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) #define CHECK_ICV_SHIFT 12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) #define INSERT_ICV BIT(13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) #define INSERT_ICV_SHIFT 13
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) #define BD_SUPPRESS BIT(19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) #define BD_SUPPRESS_SHIFT 19
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) /* Generic Mode Security Context Structure [SCTX] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) struct SCTX {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) /* word 0: protocol flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) u32 proto_flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) /* word 1: cipher flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) u32 cipher_flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) /* word 2: Extended cipher flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) u32 ecf;
^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) struct SPUHEADER {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) struct MHEADER mh;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) u32 emh;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) struct SCTX sa;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) #endif /* _SPUM_H_ */