Skip to content

Commit 2d995d8

Browse files
committed
Add versionadded placeholders for the new APIs
1 parent 66ed971 commit 2d995d8

File tree

2 files changed

+46
-1
lines changed

2 files changed

+46
-1
lines changed

doc/crypto/api/library/library.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ See :secref:`interruptible-operations`.
8787
.. summary::
8888
Set the maximum number of *ops* allowed to be executed by an interruptible function in a single call.
8989

90+
.. versionadded:: 1.x
91+
9092
.. param:: uint32_t max_ops
9193
The maximum number of ops to be executed in a single call, this can be a number from ``0`` to `PSA_IOP_MAX_OPS_UNLIMITED`, where ``0`` is obviously the least amount of work done per call.
9294

@@ -112,6 +114,8 @@ See :secref:`interruptible-operations`.
112114
.. summary::
113115
Get the maximum number of *ops* allowed to be executed by an interruptible function in a single call.
114116

117+
.. versionadded:: 1.x
118+
115119
.. return:: uint32_t
116120
Maximum number of *ops* allowed to be executed by an interruptible function in a single call.
117121

@@ -121,7 +125,8 @@ See :secref:`interruptible-operations`.
121125
:definition: UINT32_MAX
122126

123127
.. summary::
124-
125128
Maximum value for use with `psa_iop_set_max_ops()`.
126129

130+
.. versionadded:: 1.x
131+
127132
Using this value in a call to `psa_iop_set_max_ops()` will cause interruptible functions to complete their calculation before returning.

doc/crypto/api/ops/signature.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -832,6 +832,8 @@ An interruptible asymmetric signature operation is used as follows:
832832
.. summary::
833833
The type of the state data structure for an interruptible asymmetric signature operation.
834834

835+
.. versionadded:: 1.x
836+
835837
Before calling any function on an interruptible asymmetric signature operation object, the application must initialize it by any of the following means:
836838

837839
* Set the object to all-bits-zero, for example:
@@ -868,18 +870,24 @@ An interruptible asymmetric signature operation is used as follows:
868870
.. summary::
869871
This macro evaluates to an initializer for an interruptible asymmetric signature operation object of type `psa_sign_iop_t`.
870872

873+
.. versionadded:: 1.x
874+
871875
.. function:: psa_sign_iop_init
872876

873877
.. summary::
874878
Return an initial value for an interruptible asymmetric signature operation object.
875879

880+
.. versionadded:: 1.x
881+
876882
.. return:: psa_sign_iop_t
877883

878884
.. function:: psa_sign_iop_get_num_ops
879885

880886
.. summary::
881887
Get the number of *ops* that an interruptible asymmetric signature operation has taken so far.
882888

889+
.. versionadded:: 1.x
890+
883891
.. param:: psa_sign_iop_t * operation
884892
The interruptible asymmetric signature operation to inspect.
885893

@@ -897,6 +905,8 @@ An interruptible asymmetric signature operation is used as follows:
897905
.. summary::
898906
Begin the setup of an interruptible asymmetric signature operation.
899907

908+
.. versionadded:: 1.x
909+
900910
.. param:: psa_sign_iop_t * operation
901911
The interruptible asymmetric signature operation to set up. It must have been initialized as per the documentation for `psa_sign_iop_t` and not yet in use.
902912
.. param:: psa_key_id_t key
@@ -952,6 +962,8 @@ An interruptible asymmetric signature operation is used as follows:
952962
.. summary::
953963
Finish setting up an interruptible asymmetric signature operation.
954964

965+
.. versionadded:: 1.x
966+
955967
.. param:: psa_sign_iop_t * operation
956968
The interruptible asymmetric signature operation to use. The operation must be in the process of being set up.
957969

@@ -988,6 +1000,8 @@ An interruptible asymmetric signature operation is used as follows:
9881000
.. summary::
9891001
Input a pre-computed hash to an interruptible asymmetric signature operation.
9901002

1003+
.. versionadded:: 1.x
1004+
9911005
.. param:: psa_sign_iop_t * operation
9921006
The interruptible asymmetric signature operation to use. The operation must have been set up, with no data input.
9931007
.. param:: const uint8_t * hash
@@ -1039,6 +1053,8 @@ An interruptible asymmetric signature operation is used as follows:
10391053
.. summary::
10401054
Add a message fragment to an interruptible asymmetric signature operation.
10411055

1056+
.. versionadded:: 1.x
1057+
10421058
.. param:: psa_sign_iop_t * operation
10431059
The interruptible asymmetric signature operation to use. The operation must have been set up, with no hash value input.
10441060
.. param:: const uint8_t * input
@@ -1091,6 +1107,8 @@ An interruptible asymmetric signature operation is used as follows:
10911107
.. summary::
10921108
Attempt to finish the interruptible calculation of an asymmetric signature.
10931109

1110+
.. versionadded:: 1.x
1111+
10941112
.. param:: psa_sign_iop_t * operation
10951113
The interruptible asymmetric signature operation to use. The operation must have hash or message data input, or be in the process of finishing.
10961114
.. param:: uint8_t * signature
@@ -1139,6 +1157,8 @@ An interruptible asymmetric signature operation is used as follows:
11391157
.. summary::
11401158
Abort an interruptible asymmetric signature operation.
11411159

1160+
.. versionadded:: 1.x
1161+
11421162
.. param:: psa_sign_iop_t * operation
11431163
The interruptible signature operation to abort.
11441164

@@ -1184,6 +1204,8 @@ An interruptible asymmetric verification operation is used as follows:
11841204
.. summary::
11851205
The type of the state data structure for an interruptible asymmetric verification operation.
11861206

1207+
.. versionadded:: 1.x
1208+
11871209
Before calling any function on an interruptible asymmetric verification operation object, the application must initialize it by any of the following means:
11881210

11891211
* Set the object to all-bits-zero, for example:
@@ -1220,18 +1242,24 @@ An interruptible asymmetric verification operation is used as follows:
12201242
.. summary::
12211243
This macro evaluates to an initializer for an interruptible asymmetric verification operation object of type `psa_verify_iop_t`.
12221244

1245+
.. versionadded:: 1.x
1246+
12231247
.. function:: psa_verify_iop_init
12241248

12251249
.. summary::
12261250
Return an initial value for an interruptible asymmetric verification operation object.
12271251

1252+
.. versionadded:: 1.x
1253+
12281254
.. return:: psa_verify_iop_t
12291255

12301256
.. function:: psa_verify_iop_get_num_ops
12311257

12321258
.. summary::
12331259
Get the number of *ops* that an interruptible asymmetric verification operation has taken so far.
12341260

1261+
.. versionadded:: 1.x
1262+
12351263
.. param:: psa_verify_iop_t * operation
12361264
The interruptible asymmetric verification operation to inspect.
12371265

@@ -1249,6 +1277,8 @@ An interruptible asymmetric verification operation is used as follows:
12491277
.. summary::
12501278
Begin the setup of an interruptible asymmetric verification operation.
12511279

1280+
.. versionadded:: 1.x
1281+
12521282
.. param:: psa_verify_iop_t * operation
12531283
The interruptible verification operation to set up. It must have been initialized as per the documentation for `psa_verify_iop_t` and not yet in use.
12541284
.. param:: psa_key_id_t key
@@ -1310,6 +1340,8 @@ An interruptible asymmetric verification operation is used as follows:
13101340
.. summary::
13111341
Finish setting up an interruptible asymmetric verification operation.
13121342

1343+
.. versionadded:: 1.x
1344+
13131345
.. param:: psa_verify_iop_t * operation
13141346
The interruptible verification operation to use. The operation must be in the process of being set up.
13151347

@@ -1347,6 +1379,8 @@ An interruptible asymmetric verification operation is used as follows:
13471379
.. summary::
13481380
Input a pre-computed hash to an interruptible asymmetric verification operation.
13491381

1382+
.. versionadded:: 1.x
1383+
13501384
.. param:: psa_verify_iop_t * operation
13511385
The interruptible verification operation to use. The operation must have been set up, with no data input.
13521386
.. param:: const uint8_t * hash
@@ -1398,6 +1432,8 @@ An interruptible asymmetric verification operation is used as follows:
13981432
.. summary::
13991433
Add a message fragment to an interruptible asymmetric verification operation.
14001434

1435+
.. versionadded:: 1.x
1436+
14011437
.. param:: psa_verify_iop_t * operation
14021438
The interruptible verification operation to use. The operation must have been set up, with no hash value input.
14031439
.. param:: const uint8_t * input
@@ -1449,6 +1485,8 @@ An interruptible asymmetric verification operation is used as follows:
14491485
.. summary::
14501486
Attempt to finish the interruptible verification of an asymmetric signature.
14511487

1488+
.. versionadded:: 1.x
1489+
14521490
.. param:: psa_verify_iop_t * operation
14531491
The interruptible verification operation to use. The operation must have hash or message data input, or be in the process of finishing.
14541492

@@ -1486,6 +1524,8 @@ An interruptible asymmetric verification operation is used as follows:
14861524
.. summary::
14871525
Abort an interruptible asymmetric verification operation.
14881526

1527+
.. versionadded:: 1.x
1528+
14891529
.. param:: psa_verify_iop_t * operation
14901530
The interruptible verification operation to abort.
14911531

0 commit comments

Comments
 (0)