drivers/crypto/caam/error.c - linux-mtk - Git at Google

 /*
  * CAAM Error Reporting
  *
  * Copyright 2009-2011 Freescale Semiconductor, Inc.
  */

 #include "compat.h"
 #include "regs.h"
 #include "intern.h"
 #include "desc.h"
 #include "jr.h"
 #include "error.h"

 static const struct {
 	u8 value;
 	char *error_text;
 } desc_error_list[] = {
 	{ 0x00, "No error." },
 	{ 0x01, "SGT Length Error. The descriptor is trying to read "
 		"more data than is contained in the SGT table." },
 	{ 0x02, "SGT Null Entry Error." },
 	{ 0x03, "Job Ring Control Error. There is a bad value in the "
 		"Job Ring Control register." },
 	{ 0x04, "Invalid Descriptor Command. The Descriptor Command "
 		"field is invalid." },
 	{ 0x05, "Reserved." },
 	{ 0x06, "Invalid KEY Command" },
 	{ 0x07, "Invalid LOAD Command" },
 	{ 0x08, "Invalid STORE Command" },
 	{ 0x09, "Invalid OPERATION Command" },
 	{ 0x0A, "Invalid FIFO LOAD Command" },
 	{ 0x0B, "Invalid FIFO STORE Command" },
 	{ 0x0C, "Invalid MOVE/MOVE_LEN Command" },
 	{ 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." },
 	{ 0x0E, "Invalid MATH Command" },
 	{ 0x0F, "Invalid SIGNATURE Command" },
 	{ 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." },
 	{ 0x11, "Skip data type invalid. The type must be 0xE or 0xF."},
 	{ 0x12, "Shared Descriptor Header Error" },
 	{ 0x13, "Header Error. Invalid length or parity, or certain "
 		"other problems." },
 	{ 0x14, "Burster Error. Burster has gotten to an illegal "
 		"state" },
 	{ 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)." },
 	{ 0x16, "DMA Error" },
 	{ 0x17, "Reserved." },
 	{ 0x1A, "Job failed due to JR reset" },
 	{ 0x1B, "Job failed due to Fail Mode" },
 	{ 0x1C, "DECO Watchdog timer timeout error" },
 	{ 0x1D, "DECO tried to copy a key from another DECO but the "
 		"other DECO's Key Registers were locked" },
 	{ 0x1E, "DECO attempted to copy data from a DECO that had an "
 		"unmasked Descriptor error" },
 	{ 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." },
 	{ 0x20, "DECO has completed a reset initiated via the DRR "
 		"register" },
 	{ 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." },
 	{ 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)." },
 	{ 0x23, "Read Input Frame error" },
 	{ 0x24, "JDKEK, TDKEK or TDSK not loaded error" },
 	{ 0x80, "DNR (do not run) error" },
 	{ 0x81, "undefined protocol command" },
 	{ 0x82, "invalid setting in PDB" },
 	{ 0x83, "Anti-replay LATE error" },
 	{ 0x84, "Anti-replay REPLAY error" },
 	{ 0x85, "Sequence number overflow" },
 	{ 0x86, "Sigver invalid signature" },
 	{ 0x87, "DSA Sign Illegal test descriptor" },
 	{ 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." },
 	{ 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." },
 	{ 0xC1, "Blob Command error: Undefined mode" },
 	{ 0xC2, "Blob Command error: Secure Memory Blob mode error" },
 	{ 0xC4, "Blob Command error: Black Blob key or input size "
 		"error" },
 	{ 0xC5, "Blob Command error: Invalid key destination" },
 	{ 0xC8, "Blob Command error: Trusted/Secure mode error" },
 	{ 0xF0, "IPsec TTL or hop limit field either came in as 0, "
 		"or was decremented to 0" },
 	{ 0xF1, "3GPP HFN matches or exceeds the Threshold" },
 };

 static const char * const cha_id_list[] = {
 	"",
 	"AES",
 	"DES",
 	"ARC4",
 	"MDHA",
 	"RNG",
 	"SNOW f8",
 	"Kasumi f8/9",
 	"PKHA",
 	"CRCA",
 	"SNOW f9",
 	"ZUCE",
 	"ZUCA",
 };

 static const char * const err_id_list[] = {
 	"No error.",
 	"Mode error.",
 	"Data size error.",
 	"Key size error.",
 	"PKHA A memory size error.",
 	"PKHA B memory size error.",
 	"Data arrived out of sequence error.",
 	"PKHA divide-by-zero error.",
 	"PKHA modulus even error.",
 	"DES key parity error.",
 	"ICV check failed.",
 	"Hardware error.",
 	"Unsupported CCM AAD size.",
 	"Class 1 CHA is not reset",
 	"Invalid CHA combination was selected",
 	"Invalid CHA selected.",
 };

 static const char * const rng_err_id_list[] = {
 	"",
 	"",
 	"",
 	"Instantiate",
 	"Not instantiated",
 	"Test instantiate",
 	"Prediction resistance",
 	"Prediction resistance and test request",
 	"Uninstantiate",
 	"Secure key generation",
 };

 #define SPRINTFCAT(str, format, param, max_alloc)		\
 {								\
 	char *tmp;						\
 								\
 	tmp = kmalloc(sizeof(format) + max_alloc, GFP_ATOMIC);	\
 	sprintf(tmp, format, param);				\
 	strcat(str, tmp);					\
 	kfree(tmp);						\
 }

 static void report_jump_idx(u32 status, char *outstr)
 {
 	u8 idx = (status & JRSTA_DECOERR_INDEX_MASK) >>
 		  JRSTA_DECOERR_INDEX_SHIFT;

 	if (status & JRSTA_DECOERR_JUMP)
 		strcat(outstr, "jump tgt desc idx ");
 	else
 		strcat(outstr, "desc idx ");

 	SPRINTFCAT(outstr, "%d: ", idx, sizeof("255"));
 }

 static void report_ccb_status(struct device *jrdev, u32 status,
 			      const char *error, char *outstr)
 {
 	u8 cha_id = (status & JRSTA_CCBERR_CHAID_MASK) >>
 		    JRSTA_CCBERR_CHAID_SHIFT;
 	u8 err_id = status & JRSTA_CCBERR_ERRID_MASK;

 	sprintf(outstr, "%s: ", error);

 	report_jump_idx(status, outstr);

 	if (cha_id < ARRAY_SIZE(cha_id_list)) {
 		SPRINTFCAT(outstr, "%s: ", cha_id_list[cha_id],
 			   strlen(cha_id_list[cha_id]));
 	} else {
 		SPRINTFCAT(outstr, "unidentified cha_id value 0x%02x: ",
 			   cha_id, sizeof("ff"));
 	}

 	if ((cha_id << JRSTA_CCBERR_CHAID_SHIFT) == JRSTA_CCBERR_CHAID_RNG &&
 	    err_id < ARRAY_SIZE(rng_err_id_list) &&
 	    strlen(rng_err_id_list[err_id])) {
 		/* RNG-only error */
 		SPRINTFCAT(outstr, "%s", rng_err_id_list[err_id],
 			   strlen(rng_err_id_list[err_id]));
 	} else if (err_id < ARRAY_SIZE(err_id_list)) {
 		SPRINTFCAT(outstr, "%s", err_id_list[err_id],
 			   strlen(err_id_list[err_id]));
 	} else {
 		SPRINTFCAT(outstr, "unidentified err_id value 0x%02x",
 			   err_id, sizeof("ff"));
 	}
 }

 static void report_jump_status(struct device *jrdev, u32 status,
 			       const char *error, char *outstr)
 {
 	sprintf(outstr, "%s: ", error);
 	SPRINTFCAT(outstr, "%s() not implemented", __func__, sizeof(__func__));
 }

 static void report_deco_status(struct device *jrdev, u32 status,
 			       const char *error, char *outstr)
 {
 	u8 desc_error = status & JRSTA_DECOERR_ERROR_MASK;
 	int i;
 	sprintf(outstr, "%s: ", error);

 	report_jump_idx(status, outstr);

 	for (i = 0; i < ARRAY_SIZE(desc_error_list); i++)
 		if (desc_error_list[i].value == desc_error)
 			break;

 	if (i != ARRAY_SIZE(desc_error_list) && desc_error_list[i].error_text) {
 		SPRINTFCAT(outstr, "%s", desc_error_list[i].error_text,
 			   strlen(desc_error_list[i].error_text));
 	} else {
 		SPRINTFCAT(outstr, "unidentified error value 0x%02x",
 			   desc_error, sizeof("ff"));
 	}
 }

 static void report_jr_status(struct device *jrdev, u32 status,
 			     const char *error, char *outstr)
 {
 	sprintf(outstr, "%s: ", error);
 	SPRINTFCAT(outstr, "%s() not implemented", __func__, sizeof(__func__));
 }

 static void report_cond_code_status(struct device *jrdev, u32 status,
 				    const char *error, char *outstr)
 {
 	sprintf(outstr, "%s: ", error);
 	SPRINTFCAT(outstr, "%s() not implemented", __func__, sizeof(__func__));
 }

 void caam_jr_strstatus(struct device *jrdev, u32 status)
 {
 	char outstr[CAAM_ERROR_STR_MAX];
 	static const struct stat_src {
 		void (*report_ssed)(struct device *jrdev, u32 status,
 				    const char *error, char *outstr);
 		const char *error;
 	} status_src[] = {
 		{ NULL, "No error" },
 		{ NULL, NULL },
 		{ report_ccb_status, "CCB" },
 		{ report_jump_status, "Jump" },
 		{ report_deco_status, "DECO" },
 		{ NULL, NULL },
 		{ report_jr_status, "Job Ring" },
 		{ report_cond_code_status, "Condition Code" },
 	};
 	u32 ssrc = status >> JRSTA_SSRC_SHIFT;

 	/*
 	 * If there is no further error handling function, just
 	 * print the error code, error string and exit.
 	 */
 	if (!status_src[ssrc].report_ssed) {
 		dev_err(jrdev, "%08x: %s: \n", status, status_src[ssrc].error);
 		return;
 	}

 	status_src[ssrc].report_ssed(jrdev, status,
 			status_src[ssrc].error, outstr);

 	dev_err(jrdev, "%08x: %s\n", status, outstr);
 }
 EXPORT_SYMBOL(caam_jr_strstatus);
	/*
	* CAAM Error Reporting
	*
	* Copyright 2009-2011 Freescale Semiconductor, Inc.
	*/

	#include "compat.h"
	#include "regs.h"
	#include "intern.h"
	#include "desc.h"
	#include "jr.h"
	#include "error.h"

	static const struct {
	u8 value;
	char *error_text;
	} desc_error_list[] = {
	{ 0x00, "No error." },
	{ 0x01, "SGT Length Error. The descriptor is trying to read "
	"more data than is contained in the SGT table." },
	{ 0x02, "SGT Null Entry Error." },
	{ 0x03, "Job Ring Control Error. There is a bad value in the "
	"Job Ring Control register." },
	{ 0x04, "Invalid Descriptor Command. The Descriptor Command "
	"field is invalid." },
	{ 0x05, "Reserved." },
	{ 0x06, "Invalid KEY Command" },
	{ 0x07, "Invalid LOAD Command" },
	{ 0x08, "Invalid STORE Command" },
	{ 0x09, "Invalid OPERATION Command" },
	{ 0x0A, "Invalid FIFO LOAD Command" },
	{ 0x0B, "Invalid FIFO STORE Command" },
	{ 0x0C, "Invalid MOVE/MOVE_LEN Command" },
	{ 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." },
	{ 0x0E, "Invalid MATH Command" },
	{ 0x0F, "Invalid SIGNATURE Command" },
	{ 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." },
	{ 0x11, "Skip data type invalid. The type must be 0xE or 0xF."},
	{ 0x12, "Shared Descriptor Header Error" },
	{ 0x13, "Header Error. Invalid length or parity, or certain "
	"other problems." },
	{ 0x14, "Burster Error. Burster has gotten to an illegal "
	"state" },
	{ 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)." },
	{ 0x16, "DMA Error" },
	{ 0x17, "Reserved." },
	{ 0x1A, "Job failed due to JR reset" },
	{ 0x1B, "Job failed due to Fail Mode" },
	{ 0x1C, "DECO Watchdog timer timeout error" },
	{ 0x1D, "DECO tried to copy a key from another DECO but the "
	"other DECO's Key Registers were locked" },
	{ 0x1E, "DECO attempted to copy data from a DECO that had an "
	"unmasked Descriptor error" },
	{ 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." },
	{ 0x20, "DECO has completed a reset initiated via the DRR "
	"register" },
	{ 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." },
	{ 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)." },
	{ 0x23, "Read Input Frame error" },
	{ 0x24, "JDKEK, TDKEK or TDSK not loaded error" },
	{ 0x80, "DNR (do not run) error" },
	{ 0x81, "undefined protocol command" },
	{ 0x82, "invalid setting in PDB" },
	{ 0x83, "Anti-replay LATE error" },
	{ 0x84, "Anti-replay REPLAY error" },
	{ 0x85, "Sequence number overflow" },
	{ 0x86, "Sigver invalid signature" },
	{ 0x87, "DSA Sign Illegal test descriptor" },
	{ 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." },
	{ 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." },
	{ 0xC1, "Blob Command error: Undefined mode" },
	{ 0xC2, "Blob Command error: Secure Memory Blob mode error" },
	{ 0xC4, "Blob Command error: Black Blob key or input size "
	"error" },
	{ 0xC5, "Blob Command error: Invalid key destination" },
	{ 0xC8, "Blob Command error: Trusted/Secure mode error" },
	{ 0xF0, "IPsec TTL or hop limit field either came in as 0, "
	"or was decremented to 0" },
	{ 0xF1, "3GPP HFN matches or exceeds the Threshold" },
	};

	static const char * const cha_id_list[] = {
	"",
	"AES",
	"DES",
	"ARC4",
	"MDHA",
	"RNG",
	"SNOW f8",
	"Kasumi f8/9",
	"PKHA",
	"CRCA",
	"SNOW f9",
	"ZUCE",
	"ZUCA",
	};

	static const char * const err_id_list[] = {
	"No error.",
	"Mode error.",
	"Data size error.",
	"Key size error.",
	"PKHA A memory size error.",
	"PKHA B memory size error.",
	"Data arrived out of sequence error.",
	"PKHA divide-by-zero error.",
	"PKHA modulus even error.",
	"DES key parity error.",
	"ICV check failed.",
	"Hardware error.",
	"Unsupported CCM AAD size.",
	"Class 1 CHA is not reset",
	"Invalid CHA combination was selected",
	"Invalid CHA selected.",
	};

	static const char * const rng_err_id_list[] = {
	"",
	"",
	"",
	"Instantiate",
	"Not instantiated",
	"Test instantiate",
	"Prediction resistance",
	"Prediction resistance and test request",
	"Uninstantiate",
	"Secure key generation",
	};

	#define SPRINTFCAT(str, format, param, max_alloc) \
	{ \
	char *tmp; \
	\
	tmp = kmalloc(sizeof(format) + max_alloc, GFP_ATOMIC); \
	sprintf(tmp, format, param); \
	strcat(str, tmp); \
	kfree(tmp); \
	}

	static void report_jump_idx(u32 status, char *outstr)
	{
	u8 idx = (status & JRSTA_DECOERR_INDEX_MASK) >>
	JRSTA_DECOERR_INDEX_SHIFT;

	if (status & JRSTA_DECOERR_JUMP)
	strcat(outstr, "jump tgt desc idx ");
	else
	strcat(outstr, "desc idx ");

	SPRINTFCAT(outstr, "%d: ", idx, sizeof("255"));
	}

	static void report_ccb_status(struct device *jrdev, u32 status,
	const char error, char outstr)
	{
	u8 cha_id = (status & JRSTA_CCBERR_CHAID_MASK) >>
	JRSTA_CCBERR_CHAID_SHIFT;
	u8 err_id = status & JRSTA_CCBERR_ERRID_MASK;

	sprintf(outstr, "%s: ", error);

	report_jump_idx(status, outstr);

	if (cha_id < ARRAY_SIZE(cha_id_list)) {
	SPRINTFCAT(outstr, "%s: ", cha_id_list[cha_id],
	strlen(cha_id_list[cha_id]));
	} else {
	SPRINTFCAT(outstr, "unidentified cha_id value 0x%02x: ",
	cha_id, sizeof("ff"));
	}

	if ((cha_id << JRSTA_CCBERR_CHAID_SHIFT) == JRSTA_CCBERR_CHAID_RNG &&
	err_id < ARRAY_SIZE(rng_err_id_list) &&
	strlen(rng_err_id_list[err_id])) {
	/* RNG-only error */
	SPRINTFCAT(outstr, "%s", rng_err_id_list[err_id],
	strlen(rng_err_id_list[err_id]));
	} else if (err_id < ARRAY_SIZE(err_id_list)) {
	SPRINTFCAT(outstr, "%s", err_id_list[err_id],
	strlen(err_id_list[err_id]));
	} else {
	SPRINTFCAT(outstr, "unidentified err_id value 0x%02x",
	err_id, sizeof("ff"));
	}
	}

	static void report_jump_status(struct device *jrdev, u32 status,
	const char error, char outstr)
	{
	sprintf(outstr, "%s: ", error);
	SPRINTFCAT(outstr, "%s() not implemented", __func__, sizeof(__func__));
	}

	static void report_deco_status(struct device *jrdev, u32 status,
	const char error, char outstr)
	{
	u8 desc_error = status & JRSTA_DECOERR_ERROR_MASK;
	int i;
	sprintf(outstr, "%s: ", error);

	report_jump_idx(status, outstr);

	for (i = 0; i < ARRAY_SIZE(desc_error_list); i++)
	if (desc_error_list[i].value == desc_error)
	break;

	if (i != ARRAY_SIZE(desc_error_list) && desc_error_list[i].error_text) {
	SPRINTFCAT(outstr, "%s", desc_error_list[i].error_text,
	strlen(desc_error_list[i].error_text));
	} else {
	SPRINTFCAT(outstr, "unidentified error value 0x%02x",
	desc_error, sizeof("ff"));
	}
	}

	static void report_jr_status(struct device *jrdev, u32 status,
	const char error, char outstr)
	{
	sprintf(outstr, "%s: ", error);
	SPRINTFCAT(outstr, "%s() not implemented", __func__, sizeof(__func__));
	}

	static void report_cond_code_status(struct device *jrdev, u32 status,
	const char error, char outstr)
	{
	sprintf(outstr, "%s: ", error);
	SPRINTFCAT(outstr, "%s() not implemented", __func__, sizeof(__func__));
	}

	void caam_jr_strstatus(struct device *jrdev, u32 status)
	{
	char outstr[CAAM_ERROR_STR_MAX];
	static const struct stat_src {
	void (report_ssed)(struct device jrdev, u32 status,
	const char error, char outstr);
	const char *error;
	} status_src[] = {
	{ NULL, "No error" },
	{ NULL, NULL },
	{ report_ccb_status, "CCB" },
	{ report_jump_status, "Jump" },
	{ report_deco_status, "DECO" },
	{ NULL, NULL },
	{ report_jr_status, "Job Ring" },
	{ report_cond_code_status, "Condition Code" },
	};
	u32 ssrc = status >> JRSTA_SSRC_SHIFT;

	/*
	* If there is no further error handling function, just
	* print the error code, error string and exit.
	*/
	if (!status_src[ssrc].report_ssed) {
	dev_err(jrdev, "%08x: %s: \n", status, status_src[ssrc].error);
	return;
	}

	status_src[ssrc].report_ssed(jrdev, status,
	status_src[ssrc].error, outstr);

	dev_err(jrdev, "%08x: %s\n", status, outstr);
	}
	EXPORT_SYMBOL(caam_jr_strstatus);