drivers/crypto/caam/desc_constr.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * caam descriptor construction helper functions
   4  *
   5  * Copyright 2008-2012 Freescale Semiconductor, Inc.
   6  */
   7
   8 #ifndef DESC_CONSTR_H
   9 #define DESC_CONSTR_H
  10
  11 #include "desc.h"
  12 #include "regs.h"
  13
  14 #define IMMEDIATE (1 << 23)
  15 #define CAAM_CMD_SZ sizeof(u32)
  16 #define CAAM_PTR_SZ sizeof(dma_addr_t)
  17 #define CAAM_DESC_BYTES_MAX (CAAM_CMD_SZ * MAX_CAAM_DESCSIZE)
  18 #define DESC_JOB_IO_LEN (CAAM_CMD_SZ * 5 + CAAM_PTR_SZ * 3)
  19
  20 #ifdef DEBUG
  21 #define PRINT_POS do { printk(KERN_DEBUG "%02d: %s\n", desc_len(desc),\
  22                               &__func__[sizeof("append")]); } while (0)
  23 #else
  24 #define PRINT_POS
  25 #endif
  26
  27 #define SET_OK_NO_PROP_ERRORS (IMMEDIATE | LDST_CLASS_DECO | \
  28                                LDST_SRCDST_WORD_DECOCTRL | \
  29                                (LDOFF_CHG_SHARE_OK_NO_PROP << \
  30                                 LDST_OFFSET_SHIFT))
  31 #define DISABLE_AUTO_INFO_FIFO (IMMEDIATE | LDST_CLASS_DECO | \
  32                                 LDST_SRCDST_WORD_DECOCTRL | \
  33                                 (LDOFF_DISABLE_AUTO_NFIFO << LDST_OFFSET_SHIFT))
  34 #define ENABLE_AUTO_INFO_FIFO (IMMEDIATE | LDST_CLASS_DECO | \
  35                                LDST_SRCDST_WORD_DECOCTRL | \
  36                                (LDOFF_ENABLE_AUTO_NFIFO << LDST_OFFSET_SHIFT))
  37
  38 extern bool caam_little_end;
  39
  40 static inline int desc_len(u32 * const desc)
  41 {
  42         return caam32_to_cpu(*desc) & HDR_DESCLEN_MASK;
  43 }
  44
  45 static inline int desc_bytes(void * const desc)
  46 {
  47         return desc_len(desc) * CAAM_CMD_SZ;
  48 }
  49
  50 static inline u32 *desc_end(u32 * const desc)
  51 {
  52         return desc + desc_len(desc);
  53 }
  54
  55 static inline void *sh_desc_pdb(u32 * const desc)
  56 {
  57         return desc + 1;
  58 }
  59
  60 static inline void init_desc(u32 * const desc, u32 options)
  61 {
  62         *desc = cpu_to_caam32((options | HDR_ONE) + 1);
  63 }
  64
  65 static inline void init_sh_desc(u32 * const desc, u32 options)
  66 {
  67         PRINT_POS;
  68         init_desc(desc, CMD_SHARED_DESC_HDR | options);
  69 }
  70
  71 static inline void init_sh_desc_pdb(u32 * const desc, u32 options,
  72                                     size_t pdb_bytes)
  73 {
  74         u32 pdb_len = (pdb_bytes + CAAM_CMD_SZ - 1) / CAAM_CMD_SZ;
  75
  76         init_sh_desc(desc, (((pdb_len + 1) << HDR_START_IDX_SHIFT) + pdb_len) |
  77                      options);
  78 }
  79
  80 static inline void init_job_desc(u32 * const desc, u32 options)
  81 {
  82         init_desc(desc, CMD_DESC_HDR | options);
  83 }
  84
  85 static inline void init_job_desc_pdb(u32 * const desc, u32 options,
  86                                      size_t pdb_bytes)
  87 {
  88         u32 pdb_len = (pdb_bytes + CAAM_CMD_SZ - 1) / CAAM_CMD_SZ;
  89
  90         init_job_desc(desc, (((pdb_len + 1) << HDR_START_IDX_SHIFT)) | options);
  91 }
  92
  93 static inline void append_ptr(u32 * const desc, dma_addr_t ptr)
  94 {
  95         dma_addr_t *offset = (dma_addr_t *)desc_end(desc);
  96
  97         *offset = cpu_to_caam_dma(ptr);
  98
  99         (*desc) = cpu_to_caam32(caam32_to_cpu(*desc) +
 100                                 CAAM_PTR_SZ / CAAM_CMD_SZ);
 101 }
 102
 103 static inline void init_job_desc_shared(u32 * const desc, dma_addr_t ptr,
 104                                         int len, u32 options)
 105 {
 106         PRINT_POS;
 107         init_job_desc(desc, HDR_SHARED | options |
 108                       (len << HDR_START_IDX_SHIFT));
 109         append_ptr(desc, ptr);
 110 }
 111
 112 static inline void append_data(u32 * const desc, void *data, int len)
 113 {
 114         u32 *offset = desc_end(desc);
 115
 116         if (len) /* avoid sparse warning: memcpy with byte count of 0 */
 117                 memcpy(offset, data, len);
 118
 119         (*desc) = cpu_to_caam32(caam32_to_cpu(*desc) +
 120                                 (len + CAAM_CMD_SZ - 1) / CAAM_CMD_SZ);
 121 }
 122
 123 static inline void append_cmd(u32 * const desc, u32 command)
 124 {
 125         u32 *cmd = desc_end(desc);
 126
 127         *cmd = cpu_to_caam32(command);
 128
 129         (*desc) = cpu_to_caam32(caam32_to_cpu(*desc) + 1);
 130 }
 131
 132 #define append_u32 append_cmd
 133
 134 static inline void append_u64(u32 * const desc, u64 data)
 135 {
 136         u32 *offset = desc_end(desc);
 137
 138         /* Only 32-bit alignment is guaranteed in descriptor buffer */
 139         if (caam_little_end) {
 140                 *offset = cpu_to_caam32(lower_32_bits(data));
 141                 *(++offset) = cpu_to_caam32(upper_32_bits(data));
 142         } else {
 143                 *offset = cpu_to_caam32(upper_32_bits(data));
 144                 *(++offset) = cpu_to_caam32(lower_32_bits(data));
 145         }
 146
 147         (*desc) = cpu_to_caam32(caam32_to_cpu(*desc) + 2);
 148 }
 149
 150 /* Write command without affecting header, and return pointer to next word */
 151 static inline u32 *write_cmd(u32 * const desc, u32 command)
 152 {
 153         *desc = cpu_to_caam32(command);
 154
 155         return desc + 1;
 156 }
 157
 158 static inline void append_cmd_ptr(u32 * const desc, dma_addr_t ptr, int len,
 159                                   u32 command)
 160 {
 161         append_cmd(desc, command | len);
 162         append_ptr(desc, ptr);
 163 }
 164
 165 /* Write length after pointer, rather than inside command */
 166 static inline void append_cmd_ptr_extlen(u32 * const desc, dma_addr_t ptr,
 167                                          unsigned int len, u32 command)
 168 {
 169         append_cmd(desc, command);
 170         if (!(command & (SQIN_RTO | SQIN_PRE)))
 171                 append_ptr(desc, ptr);
 172         append_cmd(desc, len);
 173 }
 174
 175 static inline void append_cmd_data(u32 * const desc, void *data, int len,
 176                                    u32 command)
 177 {
 178         append_cmd(desc, command | IMMEDIATE | len);
 179         append_data(desc, data, len);
 180 }
 181
 182 #define APPEND_CMD_RET(cmd, op) \
 183 static inline u32 *append_##cmd(u32 * const desc, u32 options) \
 184 { \
 185         u32 *cmd = desc_end(desc); \
 186         PRINT_POS; \
 187         append_cmd(desc, CMD_##op | options); \
 188         return cmd; \
 189 }
 190 APPEND_CMD_RET(jump, JUMP)
 191 APPEND_CMD_RET(move, MOVE)
 192
 193 static inline void set_jump_tgt_here(u32 * const desc, u32 *jump_cmd)
 194 {
 195         *jump_cmd = cpu_to_caam32(caam32_to_cpu(*jump_cmd) |
 196                                   (desc_len(desc) - (jump_cmd - desc)));
 197 }
 198
 199 static inline void set_move_tgt_here(u32 * const desc, u32 *move_cmd)
 200 {
 201         u32 val = caam32_to_cpu(*move_cmd);
 202
 203         val &= ~MOVE_OFFSET_MASK;
 204         val |= (desc_len(desc) << (MOVE_OFFSET_SHIFT + 2)) & MOVE_OFFSET_MASK;
 205         *move_cmd = cpu_to_caam32(val);
 206 }
 207
 208 #define APPEND_CMD(cmd, op) \
 209 static inline void append_##cmd(u32 * const desc, u32 options) \
 210 { \
 211         PRINT_POS; \
 212         append_cmd(desc, CMD_##op | options); \
 213 }
 214 APPEND_CMD(operation, OPERATION)
 215
 216 #define APPEND_CMD_LEN(cmd, op) \
 217 static inline void append_##cmd(u32 * const desc, unsigned int len, \
 218                                 u32 options) \
 219 { \
 220         PRINT_POS; \
 221         append_cmd(desc, CMD_##op | len | options); \
 222 }
 223
 224 APPEND_CMD_LEN(seq_load, SEQ_LOAD)
 225 APPEND_CMD_LEN(seq_store, SEQ_STORE)
 226 APPEND_CMD_LEN(seq_fifo_load, SEQ_FIFO_LOAD)
 227 APPEND_CMD_LEN(seq_fifo_store, SEQ_FIFO_STORE)
 228
 229 #define APPEND_CMD_PTR(cmd, op) \
 230 static inline void append_##cmd(u32 * const desc, dma_addr_t ptr, \
 231                                 unsigned int len, u32 options) \
 232 { \
 233         PRINT_POS; \
 234         append_cmd_ptr(desc, ptr, len, CMD_##op | options); \
 235 }
 236 APPEND_CMD_PTR(key, KEY)
 237 APPEND_CMD_PTR(load, LOAD)
 238 APPEND_CMD_PTR(fifo_load, FIFO_LOAD)
 239 APPEND_CMD_PTR(fifo_store, FIFO_STORE)
 240
 241 static inline void append_store(u32 * const desc, dma_addr_t ptr,
 242                                 unsigned int len, u32 options)
 243 {
 244         u32 cmd_src;
 245
 246         cmd_src = options & LDST_SRCDST_MASK;
 247
 248         append_cmd(desc, CMD_STORE | options | len);
 249
 250         /* The following options do not require pointer */
 251         if (!(cmd_src == LDST_SRCDST_WORD_DESCBUF_SHARED ||
 252               cmd_src == LDST_SRCDST_WORD_DESCBUF_JOB    ||
 253               cmd_src == LDST_SRCDST_WORD_DESCBUF_JOB_WE ||
 254               cmd_src == LDST_SRCDST_WORD_DESCBUF_SHARED_WE))
 255                 append_ptr(desc, ptr);
 256 }
 257
 258 #define APPEND_SEQ_PTR_INTLEN(cmd, op) \
 259 static inline void append_seq_##cmd##_ptr_intlen(u32 * const desc, \
 260                                                  dma_addr_t ptr, \
 261                                                  unsigned int len, \
 262                                                  u32 options) \
 263 { \
 264         PRINT_POS; \
 265         if (options & (SQIN_RTO | SQIN_PRE)) \
 266                 append_cmd(desc, CMD_SEQ_##op##_PTR | len | options); \
 267         else \
 268                 append_cmd_ptr(desc, ptr, len, CMD_SEQ_##op##_PTR | options); \
 269 }
 270 APPEND_SEQ_PTR_INTLEN(in, IN)
 271 APPEND_SEQ_PTR_INTLEN(out, OUT)
 272
 273 #define APPEND_CMD_PTR_TO_IMM(cmd, op) \
 274 static inline void append_##cmd##_as_imm(u32 * const desc, void *data, \
 275                                          unsigned int len, u32 options) \
 276 { \
 277         PRINT_POS; \
 278         append_cmd_data(desc, data, len, CMD_##op | options); \
 279 }
 280 APPEND_CMD_PTR_TO_IMM(load, LOAD);
 281 APPEND_CMD_PTR_TO_IMM(fifo_load, FIFO_LOAD);
 282
 283 #define APPEND_CMD_PTR_EXTLEN(cmd, op) \
 284 static inline void append_##cmd##_extlen(u32 * const desc, dma_addr_t ptr, \
 285                                          unsigned int len, u32 options) \
 286 { \
 287         PRINT_POS; \
 288         append_cmd_ptr_extlen(desc, ptr, len, CMD_##op | SQIN_EXT | options); \
 289 }
 290 APPEND_CMD_PTR_EXTLEN(seq_in_ptr, SEQ_IN_PTR)
 291 APPEND_CMD_PTR_EXTLEN(seq_out_ptr, SEQ_OUT_PTR)
 292
 293 /*
 294  * Determine whether to store length internally or externally depending on
 295  * the size of its type
 296  */
 297 #define APPEND_CMD_PTR_LEN(cmd, op, type) \
 298 static inline void append_##cmd(u32 * const desc, dma_addr_t ptr, \
 299                                 type len, u32 options) \
 300 { \
 301         PRINT_POS; \
 302         if (sizeof(type) > sizeof(u16)) \
 303                 append_##cmd##_extlen(desc, ptr, len, options); \
 304         else \
 305                 append_##cmd##_intlen(desc, ptr, len, options); \
 306 }
 307 APPEND_CMD_PTR_LEN(seq_in_ptr, SEQ_IN_PTR, u32)
 308 APPEND_CMD_PTR_LEN(seq_out_ptr, SEQ_OUT_PTR, u32)
 309
 310 /*
 311  * 2nd variant for commands whose specified immediate length differs
 312  * from length of immediate data provided, e.g., split keys
 313  */
 314 #define APPEND_CMD_PTR_TO_IMM2(cmd, op) \
 315 static inline void append_##cmd##_as_imm(u32 * const desc, void *data, \
 316                                          unsigned int data_len, \
 317                                          unsigned int len, u32 options) \
 318 { \
 319         PRINT_POS; \
 320         append_cmd(desc, CMD_##op | IMMEDIATE | len | options); \
 321         append_data(desc, data, data_len); \
 322 }
 323 APPEND_CMD_PTR_TO_IMM2(key, KEY);
 324
 325 #define APPEND_CMD_RAW_IMM(cmd, op, type) \
 326 static inline void append_##cmd##_imm_##type(u32 * const desc, type immediate, \
 327                                              u32 options) \
 328 { \
 329         PRINT_POS; \
 330         append_cmd(desc, CMD_##op | IMMEDIATE | options | sizeof(type)); \
 331         append_cmd(desc, immediate); \
 332 }
 333 APPEND_CMD_RAW_IMM(load, LOAD, u32);
 334
 335 /*
 336  * ee - endianness
 337  * size - size of immediate type in bytes
 338  */
 339 #define APPEND_CMD_RAW_IMM2(cmd, op, ee, size) \
 340 static inline void append_##cmd##_imm_##ee##size(u32 *desc, \
 341                                                    u##size immediate, \
 342                                                    u32 options) \
 343 { \
 344         __##ee##size data = cpu_to_##ee##size(immediate); \
 345         PRINT_POS; \
 346         append_cmd(desc, CMD_##op | IMMEDIATE | options | sizeof(data)); \
 347         append_data(desc, &data, sizeof(data)); \
 348 }
 349
 350 APPEND_CMD_RAW_IMM2(load, LOAD, be, 32);
 351
 352 /*
 353  * Append math command. Only the last part of destination and source need to
 354  * be specified
 355  */
 356 #define APPEND_MATH(op, desc, dest, src_0, src_1, len) \
 357 append_cmd(desc, CMD_MATH | MATH_FUN_##op | MATH_DEST_##dest | \
 358         MATH_SRC0_##src_0 | MATH_SRC1_##src_1 | (u32)len);
 359
 360 #define append_math_add(desc, dest, src0, src1, len) \
 361         APPEND_MATH(ADD, desc, dest, src0, src1, len)
 362 #define append_math_sub(desc, dest, src0, src1, len) \
 363         APPEND_MATH(SUB, desc, dest, src0, src1, len)
 364 #define append_math_add_c(desc, dest, src0, src1, len) \
 365         APPEND_MATH(ADDC, desc, dest, src0, src1, len)
 366 #define append_math_sub_b(desc, dest, src0, src1, len) \
 367         APPEND_MATH(SUBB, desc, dest, src0, src1, len)
 368 #define append_math_and(desc, dest, src0, src1, len) \
 369         APPEND_MATH(AND, desc, dest, src0, src1, len)
 370 #define append_math_or(desc, dest, src0, src1, len) \
 371         APPEND_MATH(OR, desc, dest, src0, src1, len)
 372 #define append_math_xor(desc, dest, src0, src1, len) \
 373         APPEND_MATH(XOR, desc, dest, src0, src1, len)
 374 #define append_math_lshift(desc, dest, src0, src1, len) \
 375         APPEND_MATH(LSHIFT, desc, dest, src0, src1, len)
 376 #define append_math_rshift(desc, dest, src0, src1, len) \
 377         APPEND_MATH(RSHIFT, desc, dest, src0, src1, len)
 378 #define append_math_ldshift(desc, dest, src0, src1, len) \
 379         APPEND_MATH(SHLD, desc, dest, src0, src1, len)
 380
 381 /* Exactly one source is IMM. Data is passed in as u32 value */
 382 #define APPEND_MATH_IMM_u32(op, desc, dest, src_0, src_1, data) \
 383 do { \
 384         APPEND_MATH(op, desc, dest, src_0, src_1, CAAM_CMD_SZ); \
 385         append_cmd(desc, data); \
 386 } while (0)
 387
 388 #define append_math_add_imm_u32(desc, dest, src0, src1, data) \
 389         APPEND_MATH_IMM_u32(ADD, desc, dest, src0, src1, data)
 390 #define append_math_sub_imm_u32(desc, dest, src0, src1, data) \
 391         APPEND_MATH_IMM_u32(SUB, desc, dest, src0, src1, data)
 392 #define append_math_add_c_imm_u32(desc, dest, src0, src1, data) \
 393         APPEND_MATH_IMM_u32(ADDC, desc, dest, src0, src1, data)
 394 #define append_math_sub_b_imm_u32(desc, dest, src0, src1, data) \
 395         APPEND_MATH_IMM_u32(SUBB, desc, dest, src0, src1, data)
 396 #define append_math_and_imm_u32(desc, dest, src0, src1, data) \
 397         APPEND_MATH_IMM_u32(AND, desc, dest, src0, src1, data)
 398 #define append_math_or_imm_u32(desc, dest, src0, src1, data) \
 399         APPEND_MATH_IMM_u32(OR, desc, dest, src0, src1, data)
 400 #define append_math_xor_imm_u32(desc, dest, src0, src1, data) \
 401         APPEND_MATH_IMM_u32(XOR, desc, dest, src0, src1, data)
 402 #define append_math_lshift_imm_u32(desc, dest, src0, src1, data) \
 403         APPEND_MATH_IMM_u32(LSHIFT, desc, dest, src0, src1, data)
 404 #define append_math_rshift_imm_u32(desc, dest, src0, src1, data) \
 405         APPEND_MATH_IMM_u32(RSHIFT, desc, dest, src0, src1, data)
 406
 407 /* Exactly one source is IMM. Data is passed in as u64 value */
 408 #define APPEND_MATH_IMM_u64(op, desc, dest, src_0, src_1, data) \
 409 do { \
 410         u32 upper = (data >> 16) >> 16; \
 411         APPEND_MATH(op, desc, dest, src_0, src_1, CAAM_CMD_SZ * 2 | \
 412                     (upper ? 0 : MATH_IFB)); \
 413         if (upper) \
 414                 append_u64(desc, data); \
 415         else \
 416                 append_u32(desc, lower_32_bits(data)); \
 417 } while (0)
 418
 419 #define append_math_add_imm_u64(desc, dest, src0, src1, data) \
 420         APPEND_MATH_IMM_u64(ADD, desc, dest, src0, src1, data)
 421 #define append_math_sub_imm_u64(desc, dest, src0, src1, data) \
 422         APPEND_MATH_IMM_u64(SUB, desc, dest, src0, src1, data)
 423 #define append_math_add_c_imm_u64(desc, dest, src0, src1, data) \
 424         APPEND_MATH_IMM_u64(ADDC, desc, dest, src0, src1, data)
 425 #define append_math_sub_b_imm_u64(desc, dest, src0, src1, data) \
 426         APPEND_MATH_IMM_u64(SUBB, desc, dest, src0, src1, data)
 427 #define append_math_and_imm_u64(desc, dest, src0, src1, data) \
 428         APPEND_MATH_IMM_u64(AND, desc, dest, src0, src1, data)
 429 #define append_math_or_imm_u64(desc, dest, src0, src1, data) \
 430         APPEND_MATH_IMM_u64(OR, desc, dest, src0, src1, data)
 431 #define append_math_xor_imm_u64(desc, dest, src0, src1, data) \
 432         APPEND_MATH_IMM_u64(XOR, desc, dest, src0, src1, data)
 433 #define append_math_lshift_imm_u64(desc, dest, src0, src1, data) \
 434         APPEND_MATH_IMM_u64(LSHIFT, desc, dest, src0, src1, data)
 435 #define append_math_rshift_imm_u64(desc, dest, src0, src1, data) \
 436         APPEND_MATH_IMM_u64(RSHIFT, desc, dest, src0, src1, data)
 437
 438 /**
 439  * struct alginfo - Container for algorithm details
 440  * @algtype: algorithm selector; for valid values, see documentation of the
 441  *           functions where it is used.
 442  * @keylen: length of the provided algorithm key, in bytes
 443  * @keylen_pad: padded length of the provided algorithm key, in bytes
 444  * @key: address where algorithm key resides; virtual address if key_inline
 445  *       is true, dma (bus) address if key_inline is false.
 446  * @key_inline: true - key can be inlined in the descriptor; false - key is
 447  *              referenced by the descriptor
 448  */
 449 struct alginfo {
 450         u32 algtype;
 451         unsigned int keylen;
 452         unsigned int keylen_pad;
 453         union {
 454                 dma_addr_t key_dma;
 455                 void *key_virt;
 456         };
 457         bool key_inline;
 458 };
 459
 460 /**
 461  * desc_inline_query() - Provide indications on which data items can be inlined
 462  *                       and which shall be referenced in a shared descriptor.
 463  * @sd_base_len: Shared descriptor base length - bytes consumed by the commands,
 464  *               excluding the data items to be inlined (or corresponding
 465  *               pointer if an item is not inlined). Each cnstr_* function that
 466  *               generates descriptors should have a define mentioning
 467  *               corresponding length.
 468  * @jd_len: Maximum length of the job descriptor(s) that will be used
 469  *          together with the shared descriptor.
 470  * @data_len: Array of lengths of the data items trying to be inlined
 471  * @inl_mask: 32bit mask with bit x = 1 if data item x can be inlined, 0
 472  *            otherwise.
 473  * @count: Number of data items (size of @data_len array); must be <= 32
 474  *
 475  * Return: 0 if data can be inlined / referenced, negative value if not. If 0,
 476  *         check @inl_mask for details.
 477  */
 478 static inline int desc_inline_query(unsigned int sd_base_len,
 479                                     unsigned int jd_len, unsigned int *data_len,
 480                                     u32 *inl_mask, unsigned int count)
 481 {
 482         int rem_bytes = (int)(CAAM_DESC_BYTES_MAX - sd_base_len - jd_len);
 483         unsigned int i;
 484
 485         *inl_mask = 0;
 486         for (i = 0; (i < count) && (rem_bytes > 0); i++) {
 487                 if (rem_bytes - (int)(data_len[i] +
 488                         (count - i - 1) * CAAM_PTR_SZ) >= 0) {
 489                         rem_bytes -= data_len[i];
 490                         *inl_mask |= (1 << i);
 491                 } else {
 492                         rem_bytes -= CAAM_PTR_SZ;
 493                 }
 494         }
 495
 496         return (rem_bytes >= 0) ? 0 : -1;
 497 }
 498
 499 #endif /* DESC_CONSTR_H */