Tee client api errata #362

vincent-mailhol · 2023-11-01T18:17:13Z

Global Platform published the TEE Client API Specification v1.0 Errata and Precisions Version 2.0 in 2014. This document is not yet reflected in optee_client.

The document contains two errata:

E.1 Correct reference to TEEC_MemoryReference
E.2 Correct reference to TEEC_PARAMS_TYPE

and four precisions:

P.1 Clarify State of Operation Parameters on Return from
P.2 Add Normative Reference
P.3 Return Code When a Fatal Error Occurs in a Trusted Application
P.4 Define Additional Return Codes

The first patch of this series covers errata E.1, the second patch covers precision P.4. The third and last patch deprecates two existing return codes and suggest to use instead the ones introduced in precision P.4.

The remaining errata E.2 and precision P.1 to P.3 do not impact the implementation.

etienne-lms

Reviewed-by: Etienne Carriere <[email protected]> for commit
"tee_client_api: correct reference to TEEC_MemoryReference".

Reviewed-by: Etienne Carriere <[email protected]> for commit
"tee_client_api: define additional return codes" once comments are addressed.

etienne-lms · 2023-11-02T08:45:12Z

libteec/include/tee_client_api.h

@@ -186,6 +197,15 @@ extern "C" {
 #define TEEC_ERROR_EXTERNAL_CANCEL         0xFFFF0011
 #define TEEC_ERROR_TARGET_DEAD             0xFFFF3024
 #define TEEC_ERROR_STORAGE_NO_SPACE        0xFFFF3041
+#define TEE_ERROR_EXTERNAL_CANCEL          0xFFFF0011


Please move this line right above line 197.

My preference would have been to keep the order the same as it appears in Global Platform specification. But I do not want to argue on that. I applied your suggestion in cb92e7f.

etienne-lms · 2023-11-02T08:47:16Z

libteec/include/tee_client_api.h

+#define TEE_ERROR_EXTERNAL_CANCEL          0xFFFF0011
+#define TEE_ERROR_OVERFLOW                 0xFFFF300F
+#define TEE_ERROR_TARGET_DEAD              0xFFFF3024
+#define TEEC_ERROR_TARGET_DEAD             0xFFFF3024


Please move TEE_ERROR_TARGET_DEAD definition right above line 198 and remove below line.

Thanks for spotting the duplicate. Fixed in cb92e7f.

etienne-lms · 2023-11-02T08:49:42Z

libteec/include/tee_client_api.h

+#define TEE_ERROR_OVERFLOW                 0xFFFF300F
+#define TEE_ERROR_TARGET_DEAD              0xFFFF3024
+#define TEEC_ERROR_TARGET_DEAD             0xFFFF3024
+#define TEE_ERROR_STORAGE_NO_SPACE         0xFFFF3041


prefer TEE_ERROR_STORAGE_NO_SPACE definition right above TEEC_ERROR_STORAGE_NO_SPACE definition.

Same comment as above. I applied the suggestion in cb92e7f.

Apply the errata from [1] which fixes two typos in the definition of the paramTypes. [1] TEE Client API Specification v1.0 Errata and Precisions Version 2.0, §E.1 Correct Reference to TEEC_MemoryReference Signed-off-by: Vincent Mailhol <[email protected]> Reviewed-by: Etienne Carriere <[email protected]>

vincent-mailhol · 2023-11-02T15:24:40Z

@etienne-lms

Reviewed-by: Etienne Carriere <[email protected]> for commit "tee_client_api: correct reference to TEEC_MemoryReference".

Done

Reviewed-by: Etienne Carriere <[email protected]> for commit "tee_client_api: define additional return codes" once comments are addressed.

Done but I rewrote the description to explain the reordering. Thanks for your confirmation.

etienne-lms

One last change in commit "tee_client_api: define additional return codes" and I'm fine with the series.

etienne-lms · 2023-11-02T15:50:46Z

libteec/include/tee_client_api.h

 #define TEEC_ERROR_STORAGE_NO_SPACE        0xFFFF3041
+#define TEE_ERROR_OVERFLOW                 0xFFFF300F


To meet value ordering:

(...) #define TEEC_ERROR_EXTERNAL_CANCEL 0xFFFF0011 +#define TEE_ERROR_OVERFLOW 0xFFFF300F #define TEE_ERROR_TARGET_DEAD 0xFFFF3024 #define TEEC_ERROR_TARGET_DEAD 0xFFFF3024 #define TEE_ERROR_STORAGE_NO_SPACE 0xFFFF3041 -#define TEE_ERROR_OVERFLOW 0xFFFF300F #define TEE_ERROR_MAC_INVALID 0xFFFF3071 (...)

Applied in a9cfb99. I also reorder the entry in the documentation and amended the commit description accordingly.

The precision from [1] defines 9 additional return codes. One of them, TEEC_ERROR_TARGET_DEAD was already added in [2]. Apply the 8 other ones and reorder them by values. The added documentation is a verbatim copy of the description from [1]. Overwrite the existing documentation of TEEC_ERROR_TARGET_DEAD with the one from the specification. [1] TEE Client API Specification v1.0 Errata and Precisions Version 2.0, §P.4 Define Additional Return Codes [2] commit f2b0ed4 ("Updated related Linux Driver Refactoring") Link: OP-TEE@f2b0ed41c8c7b3 Signed-off-by: Vincent Mailhol <[email protected]> Reviewed-by: Etienne Carriere <[email protected]>

vincent-mailhol · 2023-11-03T00:40:55Z

For what it is worth: I added 6f76f14 to deprecate TEE_ERROR_EXTERNAL_CANCEL and TEE_ERROR_STORAGE_NO_SPACE.

etienne-lms

Acked-by: Etienne Carriere <[email protected]> for commit
"tee_client_api: deprecate two TEE_ERROR_* macros not in the specification".

…tion TEE_ERROR_EXTERNAL_CANCEL and TEE_ERROR_STORAGE_NO_SPACE are not part of the specification [1]. TEEC_ERROR_EXTERNAL_CANCEL and TEEC_ERROR_STORAGE_NO_SPACE should be preferred instead. Add a message in the description to deprecate these two macros, but keep them for backward compatibility. [1] TEE Client API Specification v1.0 Errata and Precisions Version 2.0, §P.4 Define Additional Return Codes Signed-off-by: Vincent Mailhol <[email protected]> Acked-by: Etienne Carriere <[email protected]>

github-actions · 2023-12-04T01:33:13Z

This pull request has been marked as a stale pull request because it has been open (more than) 30 days with no activity. Remove the stale label or add a comment, otherwise this pull request will automatically be closed in 5 days. Note, that you can always re-open a closed issue at any time.

etienne-lms · 2023-12-04T07:57:12Z

I think this P-R is ready to be merged. @jenswi-linaro, @jforissier, any comment on these changes?

jforissier · 2023-12-04T08:39:13Z

I think this P-R is ready to be merged. @jenswi-linaro, @jforissier, any comment on these changes?

It is. Thanks.

vincent-mailhol force-pushed the tee-client-api-errata branch from 6afc2ac to 4fbd0ba Compare November 1, 2023 18:33

etienne-lms reviewed Nov 2, 2023

View reviewed changes

vincent-mailhol force-pushed the tee-client-api-errata branch from 4fbd0ba to cb92e7f Compare November 2, 2023 15:21

etienne-lms reviewed Nov 2, 2023

View reviewed changes

vincent-mailhol force-pushed the tee-client-api-errata branch from cb92e7f to 6f76f14 Compare November 3, 2023 00:36

etienne-lms reviewed Nov 3, 2023

View reviewed changes

vincent-mailhol force-pushed the tee-client-api-errata branch from 6f76f14 to 8125349 Compare November 3, 2023 10:58

github-actions bot added the Stale label Dec 4, 2023

jforissier merged commit a8381cf into OP-TEE:master Dec 4, 2023
1 check passed

vincent-mailhol deleted the tee-client-api-errata branch December 4, 2023 12:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tee client api errata #362

Tee client api errata #362

vincent-mailhol commented Nov 1, 2023 •

edited

Loading

etienne-lms left a comment

etienne-lms Nov 2, 2023

vincent-mailhol Nov 2, 2023

etienne-lms Nov 2, 2023

vincent-mailhol Nov 2, 2023

etienne-lms Nov 2, 2023

vincent-mailhol Nov 2, 2023

vincent-mailhol commented Nov 2, 2023

etienne-lms left a comment

etienne-lms Nov 2, 2023

vincent-mailhol Nov 3, 2023

vincent-mailhol commented Nov 3, 2023 •

edited

Loading

etienne-lms left a comment

github-actions bot commented Dec 4, 2023

etienne-lms commented Dec 4, 2023

jforissier commented Dec 4, 2023

		#define TEEC_ERROR_STORAGE_NO_SPACE 0xFFFF3041
		#define TEE_ERROR_OVERFLOW 0xFFFF300F

Tee client api errata #362

Tee client api errata #362

Conversation

vincent-mailhol commented Nov 1, 2023 • edited Loading

etienne-lms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vincent-mailhol commented Nov 2, 2023

etienne-lms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vincent-mailhol commented Nov 3, 2023 • edited Loading

etienne-lms left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 4, 2023

etienne-lms commented Dec 4, 2023

jforissier commented Dec 4, 2023

vincent-mailhol commented Nov 1, 2023 •

edited

Loading

vincent-mailhol commented Nov 3, 2023 •

edited

Loading