drivers/crypto/caam/desc_constr.h

   1 /*
   2  * caam descriptor construction helper functions
   3  *
   4  * Copyright 2008-2012 Freescale Semiconductor, Inc.
   5  */
   6
   7 #include "desc.h"
   8
   9 #define IMMEDIATE (1 << 23)
  10 #define CAAM_CMD_SZ sizeof(u32)
  11 #define CAAM_PTR_SZ sizeof(dma_addr_t)
  12 #define CAAM_DESC_BYTES_MAX (CAAM_CMD_SZ * MAX_CAAM_DESCSIZE)
  13
  14 #ifdef DEBUG
  15 #define PRINT_POS do { printk(KERN_DEBUG "%02d: %s\n", desc_len(desc),\
  16                               &__func__[sizeof("append")]); } while (0)
  17 #else
  18 #define PRINT_POS
  19 #endif
  20
  21 #define SET_OK_NO_PROP_ERRORS (IMMEDIATE | LDST_CLASS_DECO | \
  22                                LDST_SRCDST_WORD_DECOCTRL | \
  23                                (LDOFF_CHG_SHARE_OK_NO_PROP << \
  24                                 LDST_OFFSET_SHIFT))
  25 #define DISABLE_AUTO_INFO_FIFO (IMMEDIATE | LDST_CLASS_DECO | \
  26                                 LDST_SRCDST_WORD_DECOCTRL | \
  27                                 (LDOFF_DISABLE_AUTO_NFIFO << LDST_OFFSET_SHIFT))
  28 #define ENABLE_AUTO_INFO_FIFO (IMMEDIATE | LDST_CLASS_DECO | \
  29                                LDST_SRCDST_WORD_DECOCTRL | \
  30                                (LDOFF_ENABLE_AUTO_NFIFO << LDST_OFFSET_SHIFT))
  31
  32 static inline int desc_len(u32 *desc)
  33 {
  34         return *desc & HDR_DESCLEN_MASK;
  35 }
  36
  37 static inline int desc_bytes(void *desc)
  38 {
  39         return desc_len(desc) * CAAM_CMD_SZ;
  40 }
  41
  42 static inline u32 *desc_end(u32 *desc)
  43 {
  44         return desc + desc_len(desc);
  45 }
  46
  47 static inline void *sh_desc_pdb(u32 *desc)
  48 {
  49         return desc + 1;
  50 }
  51
  52 static inline void init_desc(u32 *desc, u32 options)
  53 {
  54         *desc = (options | HDR_ONE) + 1;
  55 }
  56
  57 static inline void init_sh_desc(u32 *desc, u32 options)
  58 {
  59         PRINT_POS;
  60         init_desc(desc, CMD_SHARED_DESC_HDR | options);
  61 }
  62
  63 static inline void init_sh_desc_pdb(u32 *desc, u32 options, size_t pdb_bytes)
  64 {
  65         u32 pdb_len = (pdb_bytes + CAAM_CMD_SZ - 1) / CAAM_CMD_SZ;
  66
  67         init_sh_desc(desc, (((pdb_len + 1) << HDR_START_IDX_SHIFT) + pdb_len) |
  68                      options);
  69 }
  70
  71 static inline void init_job_desc(u32 *desc, u32 options)
  72 {
  73         init_desc(desc, CMD_DESC_HDR | options);
  74 }
  75
  76 static inline void append_ptr(u32 *desc, dma_addr_t ptr)
  77 {
  78         dma_addr_t *offset = (dma_addr_t *)desc_end(desc);
  79
  80         *offset = ptr;
  81
  82         (*desc) += CAAM_PTR_SZ / CAAM_CMD_SZ;
  83 }
  84
  85 static inline void init_job_desc_shared(u32 *desc, dma_addr_t ptr, int len,
  86                                         u32 options)
  87 {
  88         PRINT_POS;
  89         init_job_desc(desc, HDR_SHARED | options |
  90                       (len << HDR_START_IDX_SHIFT));
  91         append_ptr(desc, ptr);
  92 }
  93
  94 static inline void append_data(u32 *desc, void *data, int len)
  95 {
  96         u32 *offset = desc_end(desc);
  97
  98         if (len) /* avoid sparse warning: memcpy with byte count of 0 */
  99                 memcpy(offset, data, len);
 100
 101         (*desc) += (len + CAAM_CMD_SZ - 1) / CAAM_CMD_SZ;
 102 }
 103
 104 static inline void append_cmd(u32 *desc, u32 command)
 105 {
 106         u32 *cmd = desc_end(desc);
 107
 108         *cmd = command;
 109
 110         (*desc)++;
 111 }
 112
 113 #define append_u32 append_cmd
 114
 115 static inline void append_u64(u32 *desc, u64 data)
 116 {
 117         u32 *offset = desc_end(desc);
 118
 119         *offset = upper_32_bits(data);
 120         *(++offset) = lower_32_bits(data);
 121
 122         (*desc) += 2;
 123 }
 124
 125 /* Write command without affecting header, and return pointer to next word */
 126 static inline u32 *write_cmd(u32 *desc, u32 command)
 127 {
 128         *desc = command;
 129
 130         return desc + 1;
 131 }
 132
 133 static inline void append_cmd_ptr(u32 *desc, dma_addr_t ptr, int len,
 134                                   u32 command)
 135 {
 136         append_cmd(desc, command | len);
 137         append_ptr(desc, ptr);
 138 }
 139
 140 /* Write length after pointer, rather than inside command */
 141 static inline void append_cmd_ptr_extlen(u32 *desc, dma_addr_t ptr,
 142                                          unsigned int len, u32 command)
 143 {
 144         append_cmd(desc, command);
 145         if (!(command & (SQIN_RTO | SQIN_PRE)))
 146                 append_ptr(desc, ptr);
 147         append_cmd(desc, len);
 148 }
 149
 150 static inline void append_cmd_data(u32 *desc, void *data, int len,
 151                                    u32 command)
 152 {
 153         append_cmd(desc, command | IMMEDIATE | len);
 154         append_data(desc, data, len);
 155 }
 156
 157 static inline u32 *append_jump(u32 *desc, u32 options)
 158 {
 159         u32 *cmd = desc_end(desc);
 160
 161         PRINT_POS;
 162         append_cmd(desc, CMD_JUMP | options);
 163
 164         return cmd;
 165 }
 166
 167 static inline void set_jump_tgt_here(u32 *desc, u32 *jump_cmd)
 168 {
 169         *jump_cmd = *jump_cmd | (desc_len(desc) - (jump_cmd - desc));
 170 }
 171
 172 #define APPEND_CMD(cmd, op) \
 173 static inline void append_##cmd(u32 *desc, u32 options) \
 174 { \
 175         PRINT_POS; \
 176         append_cmd(desc, CMD_##op | options); \
 177 }
 178 APPEND_CMD(operation, OPERATION)
 179 APPEND_CMD(move, MOVE)
 180
 181 #define APPEND_CMD_LEN(cmd, op) \
 182 static inline void append_##cmd(u32 *desc, unsigned int len, u32 options) \
 183 { \
 184         PRINT_POS; \
 185         append_cmd(desc, CMD_##op | len | options); \
 186 }
 187 APPEND_CMD_LEN(seq_store, SEQ_STORE)
 188 APPEND_CMD_LEN(seq_fifo_load, SEQ_FIFO_LOAD)
 189 APPEND_CMD_LEN(seq_fifo_store, SEQ_FIFO_STORE)
 190
 191 #define APPEND_CMD_PTR(cmd, op) \
 192 static inline void append_##cmd(u32 *desc, dma_addr_t ptr, unsigned int len, \
 193                                 u32 options) \
 194 { \
 195         PRINT_POS; \
 196         append_cmd_ptr(desc, ptr, len, CMD_##op | options); \
 197 }
 198 APPEND_CMD_PTR(key, KEY)
 199 APPEND_CMD_PTR(load, LOAD)
 200 APPEND_CMD_PTR(fifo_load, FIFO_LOAD)
 201 APPEND_CMD_PTR(fifo_store, FIFO_STORE)
 202
 203 static inline void append_store(u32 *desc, dma_addr_t ptr, unsigned int len,
 204                                 u32 options)
 205 {
 206         u32 cmd_src;
 207
 208         cmd_src = options & LDST_SRCDST_MASK;
 209
 210         append_cmd(desc, CMD_STORE | options | len);
 211
 212         /* The following options do not require pointer */
 213         if (!(cmd_src == LDST_SRCDST_WORD_DESCBUF_SHARED ||
 214               cmd_src == LDST_SRCDST_WORD_DESCBUF_JOB    ||
 215               cmd_src == LDST_SRCDST_WORD_DESCBUF_JOB_WE ||
 216               cmd_src == LDST_SRCDST_WORD_DESCBUF_SHARED_WE))
 217                 append_ptr(desc, ptr);
 218 }
 219
 220 #define APPEND_SEQ_PTR_INTLEN(cmd, op) \
 221 static inline void append_seq_##cmd##_ptr_intlen(u32 *desc, dma_addr_t ptr, \
 222                                                  unsigned int len, \
 223                                                  u32 options) \
 224 { \
 225         PRINT_POS; \
 226         if (options & (SQIN_RTO | SQIN_PRE)) \
 227                 append_cmd(desc, CMD_SEQ_##op##_PTR | len | options); \
 228         else \
 229                 append_cmd_ptr(desc, ptr, len, CMD_SEQ_##op##_PTR | options); \
 230 }
 231 APPEND_SEQ_PTR_INTLEN(in, IN)
 232 APPEND_SEQ_PTR_INTLEN(out, OUT)
 233
 234 #define APPEND_CMD_PTR_TO_IMM(cmd, op) \
 235 static inline void append_##cmd##_as_imm(u32 *desc, void *data, \
 236                                          unsigned int len, u32 options) \
 237 { \
 238         PRINT_POS; \
 239         append_cmd_data(desc, data, len, CMD_##op | options); \
 240 }
 241 APPEND_CMD_PTR_TO_IMM(load, LOAD);
 242 APPEND_CMD_PTR_TO_IMM(fifo_load, FIFO_LOAD);
 243
 244 #define APPEND_CMD_PTR_EXTLEN(cmd, op) \
 245 static inline void append_##cmd##_extlen(u32 *desc, dma_addr_t ptr, \
 246                                          unsigned int len, u32 options) \
 247 { \
 248         PRINT_POS; \
 249         append_cmd_ptr_extlen(desc, ptr, len, CMD_##op | SQIN_EXT | options); \
 250 }
 251 APPEND_CMD_PTR_EXTLEN(seq_in_ptr, SEQ_IN_PTR)
 252 APPEND_CMD_PTR_EXTLEN(seq_out_ptr, SEQ_OUT_PTR)
 253
 254 /*
 255  * Determine whether to store length internally or externally depending on
 256  * the size of its type
 257  */
 258 #define APPEND_CMD_PTR_LEN(cmd, op, type) \
 259 static inline void append_##cmd(u32 *desc, dma_addr_t ptr, \
 260                                 type len, u32 options) \
 261 { \
 262         PRINT_POS; \
 263         if (sizeof(type) > sizeof(u16)) \
 264                 append_##cmd##_extlen(desc, ptr, len, options); \
 265         else \
 266                 append_##cmd##_intlen(desc, ptr, len, options); \
 267 }
 268 APPEND_CMD_PTR_LEN(seq_in_ptr, SEQ_IN_PTR, u32)
 269 APPEND_CMD_PTR_LEN(seq_out_ptr, SEQ_OUT_PTR, u32)
 270
 271 /*
 272  * 2nd variant for commands whose specified immediate length differs
 273  * from length of immediate data provided, e.g., split keys
 274  */
 275 #define APPEND_CMD_PTR_TO_IMM2(cmd, op) \
 276 static inline void append_##cmd##_as_imm(u32 *desc, void *data, \
 277                                          unsigned int data_len, \
 278                                          unsigned int len, u32 options) \
 279 { \
 280         PRINT_POS; \
 281         append_cmd(desc, CMD_##op | IMMEDIATE | len | options); \
 282         append_data(desc, data, data_len); \
 283 }
 284 APPEND_CMD_PTR_TO_IMM2(key, KEY);
 285
 286 #define APPEND_CMD_RAW_IMM(cmd, op, type) \
 287 static inline void append_##cmd##_imm_##type(u32 *desc, type immediate, \
 288                                              u32 options) \
 289 { \
 290         PRINT_POS; \
 291         append_cmd(desc, CMD_##op | IMMEDIATE | options | sizeof(type)); \
 292         append_cmd(desc, immediate); \
 293 }
 294 APPEND_CMD_RAW_IMM(load, LOAD, u32);
 295
 296 /*
 297  * Append math command. Only the last part of destination and source need to
 298  * be specified
 299  */
 300 #define APPEND_MATH(op, desc, dest, src_0, src_1, len) \
 301 append_cmd(desc, CMD_MATH | MATH_FUN_##op | MATH_DEST_##dest | \
 302         MATH_SRC0_##src_0 | MATH_SRC1_##src_1 | (u32)len);
 303
 304 #define append_math_add(desc, dest, src0, src1, len) \
 305         APPEND_MATH(ADD, desc, dest, src0, src1, len)
 306 #define append_math_sub(desc, dest, src0, src1, len) \
 307         APPEND_MATH(SUB, desc, dest, src0, src1, len)
 308 #define append_math_add_c(desc, dest, src0, src1, len) \
 309         APPEND_MATH(ADDC, desc, dest, src0, src1, len)
 310 #define append_math_sub_b(desc, dest, src0, src1, len) \
 311         APPEND_MATH(SUBB, desc, dest, src0, src1, len)
 312 #define append_math_and(desc, dest, src0, src1, len) \
 313         APPEND_MATH(AND, desc, dest, src0, src1, len)
 314 #define append_math_or(desc, dest, src0, src1, len) \
 315         APPEND_MATH(OR, desc, dest, src0, src1, len)
 316 #define append_math_xor(desc, dest, src0, src1, len) \
 317         APPEND_MATH(XOR, desc, dest, src0, src1, len)
 318 #define append_math_lshift(desc, dest, src0, src1, len) \
 319         APPEND_MATH(LSHIFT, desc, dest, src0, src1, len)
 320 #define append_math_rshift(desc, dest, src0, src1, len) \
 321         APPEND_MATH(RSHIFT, desc, dest, src0, src1, len)
 322 #define append_math_ldshift(desc, dest, src0, src1, len) \
 323         APPEND_MATH(SHLD, desc, dest, src0, src1, len)
 324
 325 /* Exactly one source is IMM. Data is passed in as u32 value */
 326 #define APPEND_MATH_IMM_u32(op, desc, dest, src_0, src_1, data) \
 327 do { \
 328         APPEND_MATH(op, desc, dest, src_0, src_1, CAAM_CMD_SZ); \
 329         append_cmd(desc, data); \
 330 } while (0);
 331
 332 #define append_math_add_imm_u32(desc, dest, src0, src1, data) \
 333         APPEND_MATH_IMM_u32(ADD, desc, dest, src0, src1, data)
 334 #define append_math_sub_imm_u32(desc, dest, src0, src1, data) \
 335         APPEND_MATH_IMM_u32(SUB, desc, dest, src0, src1, data)
 336 #define append_math_add_c_imm_u32(desc, dest, src0, src1, data) \
 337         APPEND_MATH_IMM_u32(ADDC, desc, dest, src0, src1, data)
 338 #define append_math_sub_b_imm_u32(desc, dest, src0, src1, data) \
 339         APPEND_MATH_IMM_u32(SUBB, desc, dest, src0, src1, data)
 340 #define append_math_and_imm_u32(desc, dest, src0, src1, data) \
 341         APPEND_MATH_IMM_u32(AND, desc, dest, src0, src1, data)
 342 #define append_math_or_imm_u32(desc, dest, src0, src1, data) \
 343         APPEND_MATH_IMM_u32(OR, desc, dest, src0, src1, data)
 344 #define append_math_xor_imm_u32(desc, dest, src0, src1, data) \
 345         APPEND_MATH_IMM_u32(XOR, desc, dest, src0, src1, data)
 346 #define append_math_lshift_imm_u32(desc, dest, src0, src1, data) \
 347         APPEND_MATH_IMM_u32(LSHIFT, desc, dest, src0, src1, data)
 348 #define append_math_rshift_imm_u32(desc, dest, src0, src1, data) \
 349         APPEND_MATH_IMM_u32(RSHIFT, desc, dest, src0, src1, data)
 350
 351 /* Exactly one source is IMM. Data is passed in as u64 value */
 352 #define APPEND_MATH_IMM_u64(op, desc, dest, src_0, src_1, data) \
 353 do { \
 354         u32 upper = (data >> 16) >> 16; \
 355         APPEND_MATH(op, desc, dest, src_0, src_1, CAAM_CMD_SZ * 2 | \
 356                     (upper ? 0 : MATH_IFB)); \
 357         if (upper) \
 358                 append_u64(desc, data); \
 359         else \
 360                 append_u32(desc, data); \
 361 } while (0)
 362
 363 #define append_math_add_imm_u64(desc, dest, src0, src1, data) \
 364         APPEND_MATH_IMM_u64(ADD, desc, dest, src0, src1, data)
 365 #define append_math_sub_imm_u64(desc, dest, src0, src1, data) \
 366         APPEND_MATH_IMM_u64(SUB, desc, dest, src0, src1, data)
 367 #define append_math_add_c_imm_u64(desc, dest, src0, src1, data) \
 368         APPEND_MATH_IMM_u64(ADDC, desc, dest, src0, src1, data)
 369 #define append_math_sub_b_imm_u64(desc, dest, src0, src1, data) \
 370         APPEND_MATH_IMM_u64(SUBB, desc, dest, src0, src1, data)
 371 #define append_math_and_imm_u64(desc, dest, src0, src1, data) \
 372         APPEND_MATH_IMM_u64(AND, desc, dest, src0, src1, data)
 373 #define append_math_or_imm_u64(desc, dest, src0, src1, data) \
 374         APPEND_MATH_IMM_u64(OR, desc, dest, src0, src1, data)
 375 #define append_math_xor_imm_u64(desc, dest, src0, src1, data) \
 376         APPEND_MATH_IMM_u64(XOR, desc, dest, src0, src1, data)
 377 #define append_math_lshift_imm_u64(desc, dest, src0, src1, data) \
 378         APPEND_MATH_IMM_u64(LSHIFT, desc, dest, src0, src1, data)
 379 #define append_math_rshift_imm_u64(desc, dest, src0, src1, data) \
 380         APPEND_MATH_IMM_u64(RSHIFT, desc, dest, src0, src1, data)