error.c 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. /*
  2. * CAAM Error Reporting
  3. *
  4. * Copyright 2009-2011 Freescale Semiconductor, Inc.
  5. */
  6. #include "compat.h"
  7. #include "regs.h"
  8. #include "intern.h"
  9. #include "desc.h"
  10. #include "jr.h"
  11. #include "error.h"
  12. static const struct {
  13. u8 value;
  14. const char *error_text;
  15. } desc_error_list[] = {
  16. { 0x00, "No error." },
  17. { 0x01, "SGT Length Error. The descriptor is trying to read more data than is contained in the SGT table." },
  18. { 0x02, "SGT Null Entry Error." },
  19. { 0x03, "Job Ring Control Error. There is a bad value in the Job Ring Control register." },
  20. { 0x04, "Invalid Descriptor Command. The Descriptor Command field is invalid." },
  21. { 0x05, "Reserved." },
  22. { 0x06, "Invalid KEY Command" },
  23. { 0x07, "Invalid LOAD Command" },
  24. { 0x08, "Invalid STORE Command" },
  25. { 0x09, "Invalid OPERATION Command" },
  26. { 0x0A, "Invalid FIFO LOAD Command" },
  27. { 0x0B, "Invalid FIFO STORE Command" },
  28. { 0x0C, "Invalid MOVE/MOVE_LEN Command" },
  29. { 0x0D, "Invalid JUMP Command. A nonlocal JUMP Command is invalid because the target is not a Job Header Command, or the jump is from a Trusted Descriptor to a Job Descriptor, or because the target Descriptor contains a Shared Descriptor." },
  30. { 0x0E, "Invalid MATH Command" },
  31. { 0x0F, "Invalid SIGNATURE Command" },
  32. { 0x10, "Invalid Sequence Command. A SEQ IN PTR OR SEQ OUT PTR Command is invalid or a SEQ KEY, SEQ LOAD, SEQ FIFO LOAD, or SEQ FIFO STORE decremented the input or output sequence length below 0. This error may result if a built-in PROTOCOL Command has encountered a malformed PDU." },
  33. { 0x11, "Skip data type invalid. The type must be 0xE or 0xF."},
  34. { 0x12, "Shared Descriptor Header Error" },
  35. { 0x13, "Header Error. Invalid length or parity, or certain other problems." },
  36. { 0x14, "Burster Error. Burster has gotten to an illegal state" },
  37. { 0x15, "Context Register Length Error. The descriptor is trying to read or write past the end of the Context Register. A SEQ LOAD or SEQ STORE with the VLF bit set was executed with too large a length in the variable length register (VSOL for SEQ STORE or VSIL for SEQ LOAD)." },
  38. { 0x16, "DMA Error" },
  39. { 0x17, "Reserved." },
  40. { 0x1A, "Job failed due to JR reset" },
  41. { 0x1B, "Job failed due to Fail Mode" },
  42. { 0x1C, "DECO Watchdog timer timeout error" },
  43. { 0x1D, "DECO tried to copy a key from another DECO but the other DECO's Key Registers were locked" },
  44. { 0x1E, "DECO attempted to copy data from a DECO that had an unmasked Descriptor error" },
  45. { 0x1F, "LIODN error. DECO was trying to share from itself or from another DECO but the two Non-SEQ LIODN values didn't match or the 'shared from' DECO's Descriptor required that the SEQ LIODNs be the same and they aren't." },
  46. { 0x20, "DECO has completed a reset initiated via the DRR register" },
  47. { 0x21, "Nonce error. When using EKT (CCM) key encryption option in the FIFO STORE Command, the Nonce counter reached its maximum value and this encryption mode can no longer be used." },
  48. { 0x22, "Meta data is too large (> 511 bytes) for TLS decap (input frame; block ciphers) and IPsec decap (output frame, when doing the next header byte update) and DCRC (output frame)." },
  49. { 0x23, "Read Input Frame error" },
  50. { 0x24, "JDKEK, TDKEK or TDSK not loaded error" },
  51. { 0x80, "DNR (do not run) error" },
  52. { 0x81, "undefined protocol command" },
  53. { 0x82, "invalid setting in PDB" },
  54. { 0x83, "Anti-replay LATE error" },
  55. { 0x84, "Anti-replay REPLAY error" },
  56. { 0x85, "Sequence number overflow" },
  57. { 0x86, "Sigver invalid signature" },
  58. { 0x87, "DSA Sign Illegal test descriptor" },
  59. { 0x88, "Protocol Format Error - A protocol has seen an error in the format of data received. When running RSA, this means that formatting with random padding was used, and did not follow the form: 0x00, 0x02, 8-to-N bytes of non-zero pad, 0x00, F data." },
  60. { 0x89, "Protocol Size Error - A protocol has seen an error in size. When running RSA, pdb size N < (size of F) when no formatting is used; or pdb size N < (F + 11) when formatting is used." },
  61. { 0xC1, "Blob Command error: Undefined mode" },
  62. { 0xC2, "Blob Command error: Secure Memory Blob mode error" },
  63. { 0xC4, "Blob Command error: Black Blob key or input size error" },
  64. { 0xC5, "Blob Command error: Invalid key destination" },
  65. { 0xC8, "Blob Command error: Trusted/Secure mode error" },
  66. { 0xF0, "IPsec TTL or hop limit field either came in as 0, or was decremented to 0" },
  67. { 0xF1, "3GPP HFN matches or exceeds the Threshold" },
  68. };
  69. static const char * const cha_id_list[] = {
  70. "",
  71. "AES",
  72. "DES",
  73. "ARC4",
  74. "MDHA",
  75. "RNG",
  76. "SNOW f8",
  77. "Kasumi f8/9",
  78. "PKHA",
  79. "CRCA",
  80. "SNOW f9",
  81. "ZUCE",
  82. "ZUCA",
  83. };
  84. static const char * const err_id_list[] = {
  85. "No error.",
  86. "Mode error.",
  87. "Data size error.",
  88. "Key size error.",
  89. "PKHA A memory size error.",
  90. "PKHA B memory size error.",
  91. "Data arrived out of sequence error.",
  92. "PKHA divide-by-zero error.",
  93. "PKHA modulus even error.",
  94. "DES key parity error.",
  95. "ICV check failed.",
  96. "Hardware error.",
  97. "Unsupported CCM AAD size.",
  98. "Class 1 CHA is not reset",
  99. "Invalid CHA combination was selected",
  100. "Invalid CHA selected.",
  101. };
  102. static const char * const rng_err_id_list[] = {
  103. "",
  104. "",
  105. "",
  106. "Instantiate",
  107. "Not instantiated",
  108. "Test instantiate",
  109. "Prediction resistance",
  110. "Prediction resistance and test request",
  111. "Uninstantiate",
  112. "Secure key generation",
  113. };
  114. static void report_ccb_status(struct device *jrdev, const u32 status,
  115. const char *error)
  116. {
  117. u8 cha_id = (status & JRSTA_CCBERR_CHAID_MASK) >>
  118. JRSTA_CCBERR_CHAID_SHIFT;
  119. u8 err_id = status & JRSTA_CCBERR_ERRID_MASK;
  120. u8 idx = (status & JRSTA_DECOERR_INDEX_MASK) >>
  121. JRSTA_DECOERR_INDEX_SHIFT;
  122. char *idx_str;
  123. const char *cha_str = "unidentified cha_id value 0x";
  124. char cha_err_code[3] = { 0 };
  125. const char *err_str = "unidentified err_id value 0x";
  126. char err_err_code[3] = { 0 };
  127. if (status & JRSTA_DECOERR_JUMP)
  128. idx_str = "jump tgt desc idx";
  129. else
  130. idx_str = "desc idx";
  131. if (cha_id < ARRAY_SIZE(cha_id_list))
  132. cha_str = cha_id_list[cha_id];
  133. else
  134. snprintf(cha_err_code, sizeof(cha_err_code), "%02x", cha_id);
  135. if ((cha_id << JRSTA_CCBERR_CHAID_SHIFT) == JRSTA_CCBERR_CHAID_RNG &&
  136. err_id < ARRAY_SIZE(rng_err_id_list) &&
  137. strlen(rng_err_id_list[err_id])) {
  138. /* RNG-only error */
  139. err_str = rng_err_id_list[err_id];
  140. } else if (err_id < ARRAY_SIZE(err_id_list))
  141. err_str = err_id_list[err_id];
  142. else
  143. snprintf(err_err_code, sizeof(err_err_code), "%02x", err_id);
  144. /*
  145. * CCB ICV check failures are part of normal operation life;
  146. * we leave the upper layers to do what they want with them.
  147. */
  148. if (err_id != JRSTA_CCBERR_ERRID_ICVCHK)
  149. dev_err(jrdev, "%08x: %s: %s %d: %s%s: %s%s\n",
  150. status, error, idx_str, idx,
  151. cha_str, cha_err_code,
  152. err_str, err_err_code);
  153. }
  154. static void report_jump_status(struct device *jrdev, const u32 status,
  155. const char *error)
  156. {
  157. dev_err(jrdev, "%08x: %s: %s() not implemented\n",
  158. status, error, __func__);
  159. }
  160. static void report_deco_status(struct device *jrdev, const u32 status,
  161. const char *error)
  162. {
  163. u8 err_id = status & JRSTA_DECOERR_ERROR_MASK;
  164. u8 idx = (status & JRSTA_DECOERR_INDEX_MASK) >>
  165. JRSTA_DECOERR_INDEX_SHIFT;
  166. char *idx_str;
  167. const char *err_str = "unidentified error value 0x";
  168. char err_err_code[3] = { 0 };
  169. int i;
  170. if (status & JRSTA_DECOERR_JUMP)
  171. idx_str = "jump tgt desc idx";
  172. else
  173. idx_str = "desc idx";
  174. for (i = 0; i < ARRAY_SIZE(desc_error_list); i++)
  175. if (desc_error_list[i].value == err_id)
  176. break;
  177. if (i != ARRAY_SIZE(desc_error_list) && desc_error_list[i].error_text)
  178. err_str = desc_error_list[i].error_text;
  179. else
  180. snprintf(err_err_code, sizeof(err_err_code), "%02x", err_id);
  181. dev_err(jrdev, "%08x: %s: %s %d: %s%s\n",
  182. status, error, idx_str, idx, err_str, err_err_code);
  183. }
  184. static void report_jr_status(struct device *jrdev, const u32 status,
  185. const char *error)
  186. {
  187. dev_err(jrdev, "%08x: %s: %s() not implemented\n",
  188. status, error, __func__);
  189. }
  190. static void report_cond_code_status(struct device *jrdev, const u32 status,
  191. const char *error)
  192. {
  193. dev_err(jrdev, "%08x: %s: %s() not implemented\n",
  194. status, error, __func__);
  195. }
  196. void caam_jr_strstatus(struct device *jrdev, u32 status)
  197. {
  198. static const struct stat_src {
  199. void (*report_ssed)(struct device *jrdev, const u32 status,
  200. const char *error);
  201. const char *error;
  202. } status_src[16] = {
  203. { NULL, "No error" },
  204. { NULL, NULL },
  205. { report_ccb_status, "CCB" },
  206. { report_jump_status, "Jump" },
  207. { report_deco_status, "DECO" },
  208. { NULL, "Queue Manager Interface" },
  209. { report_jr_status, "Job Ring" },
  210. { report_cond_code_status, "Condition Code" },
  211. { NULL, NULL },
  212. { NULL, NULL },
  213. { NULL, NULL },
  214. { NULL, NULL },
  215. { NULL, NULL },
  216. { NULL, NULL },
  217. { NULL, NULL },
  218. { NULL, NULL },
  219. };
  220. u32 ssrc = status >> JRSTA_SSRC_SHIFT;
  221. const char *error = status_src[ssrc].error;
  222. /*
  223. * If there is an error handling function, call it to report the error.
  224. * Otherwise print the error source name.
  225. */
  226. if (status_src[ssrc].report_ssed)
  227. status_src[ssrc].report_ssed(jrdev, status, error);
  228. else if (error)
  229. dev_err(jrdev, "%d: %s\n", ssrc, error);
  230. else
  231. dev_err(jrdev, "%d: unknown error source\n", ssrc);
  232. }
  233. EXPORT_SYMBOL(caam_jr_strstatus);