mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2024-12-26 18:45:29 +00:00
Clarify documentation of MBEDTLS_MPS_STATE_VALIDATION
Signed-off-by: Hanno Becker <hanno.becker@arm.com>
This commit is contained in:
parent
53314aade1
commit
6e3484e123
|
@ -61,12 +61,15 @@
|
||||||
* non-sensical calls or not, and that's what this option is about:
|
* non-sensical calls or not, and that's what this option is about:
|
||||||
*
|
*
|
||||||
* This option determines whether the expected abstract state
|
* This option determines whether the expected abstract state
|
||||||
* is part of the API preconditions or not. If it is, the function's
|
* is part of the API preconditions or not: If the option is set,
|
||||||
* behavior is undefined if the abstract state is not as expected.
|
* then the abstract state is not part of the precondition and is
|
||||||
* If it is set, API is required to fail gracefully with error
|
* thus required to be validated by the implementation. If an unexpected
|
||||||
* #MBEDTLS_ERR_MPS_OPERATION_UNEXPECTED, and without changing the abstract
|
* abstract state is encountered, the implementation must fail gracefully
|
||||||
* state of the input context, if the abstract state is unexpected but
|
* with error #MBEDTLS_ERR_MPS_OPERATION_UNEXPECTED.
|
||||||
* all other preconditions are satisfied.
|
* Conversely, if this option is not set, then the expected abstract state
|
||||||
|
* is included in the preconditions of the respective API calls, and
|
||||||
|
* an implementation's behaviour is undefined if the abstract state is
|
||||||
|
* not as expected.
|
||||||
*
|
*
|
||||||
* For example: Enabling this makes mps_l2_read_done() fail if
|
* For example: Enabling this makes mps_l2_read_done() fail if
|
||||||
* no incoming record is currently open; disabling this would
|
* no incoming record is currently open; disabling this would
|
||||||
|
|
Loading…
Reference in a new issue