Public Key Acceleration Library Reference Guide
1.0
|
Go to the documentation of this file.
132 #include <linux/types.h>
142 #define PKA_INSTANCE_INVALID 0
148 #define PKA_HANDLE_INVALID NULL
203 uint32_t cmd_queue_size,
204 uint32_t result_queue_size);
251 #define MAX_OPERAND_CNT 11
257 #define MAX_RESULT_CNT 2
261 #define MAX_BYTE_LEN 520 // 130 * 4 bytes
266 #define OTHER_MAX_BYTE_LEN 264 // 66 * 4 bytes
272 #define MAX_RESULT_CNT 2
pka_result_code_t status
Same as result_code.
Definition: pka.h:408
void pka_term_global(pka_instance_t instance)
uint8_t * pka_get_rings_bitmask(pka_instance_t instance)
uint8_t big_endian
Indicates byte order of the big integer operand.
Definition: pka.h:282
@ RC_ENCRYPTED_PARAM_ERR
Illegal encrypted parameter use.
Definition: pka.h:381
@ CC_ECDSA_GENERATE
ECDSA signature generation (high-level PKA operations).
Definition: pka.h:326
@ PKA_F_SYNC_MODE_DISABLE
Definition: pka.h:172
pka_operand_t x
big integer x coordinate of a point on a EC curve
Definition: pka.h:771
int pka_modular_inverse(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *modulus)
int pka_shift_left(pka_handle_t handle, void *user_data, pka_operand_t *value, uint32_t shift_cnt)
int pka_add_subtract(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *addend, pka_operand_t *subtrahend)
@ RC_UNKNOWN_COMMAND
Unknown command.
Definition: pka.h:361
@ CC_MODULO
Modulo (basic arithmetic).
Definition: pka.h:304
@ RC_ZERO_EXPONENT
Exponent was 0 (for a modular exponentiation).
Definition: pka.h:351
@ CC_SUBTRACT
Subtract (basic arithmetic).
Definition: pka.h:294
@ CC_MULTIPLY
Definition: pka.h:300
void pka_term_local(pka_handle_t handle)
@ CC_SHIFT_LEFT
Shift left (basic arithmetic).
Definition: pka.h:306
pka_cmp_code_t
PKA Compare Result Code Values.
Definition: pka.h:389
int pka_dsa_signature_generate(pka_handle_t handle, void *user_data, pka_operand_t *p, pka_operand_t *q, pka_operand_t *g, pka_operand_t *private_key, pka_operand_t *hash, pka_operand_t *k)
@ RC_OPERAND_LENGTH_ERR
Operand length error.
Definition: pka.h:369
@ CC_MODULAR_INVERT
Modular Inversion (complex arithmetic).
Definition: pka.h:318
pka_operand_t y
big integer y coordinate of a point on a EC curve
Definition: pka.h:772
@ PKA_CURVE_448
Definition: pka.h:798
@ RC_NO_ERROR
No error – Normal command completion.
Definition: pka.h:347
pka_instance_t pka_init_global(const char *name, uint8_t flags, uint32_t ring_cnt, uint32_t queue_cnt, uint32_t cmd_queue_size, uint32_t result_queue_size)
int pka_dsa_signature_verify(pka_handle_t handle, void *user_data, pka_operand_t *p, pka_operand_t *q, pka_operand_t *g, pka_operand_t *public_key, pka_operand_t *hash, dsa_signature_t *rcvd_signature, uint8_t no_write)
pka_operand_t a
coefficient of x in the defining equation
Definition: pka.h:790
int pka_modular_exp_crt(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *p, pka_operand_t *q, pka_operand_t *d_p, pka_operand_t *d_q, pka_operand_t *qinv)
@ RC_CALCULATION_ERR
Calculated value error.
Definition: pka.h:377
@ PKA_F_PROCESS_MODE_MULTI
Definition: pka.h:166
int pka_add(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *addend)
pka_cmp_code_t compare_result
Result of a comparison.
Definition: pka.h:409
@ PKA_CURVE_25519
Definition: pka.h:797
@ CC_ECDSA_VERIFY_NO_WRITE
Definition: pka.h:337
struct pka_local_info_t * pka_handle_t
PK handle (opaque) type that encapsulates local information.
Definition: pka.h:145
int pka_multiply(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *multiplier)
@ RC_EVEN_MODULUS
Modulus was even.
Definition: pka.h:349
@ RC_INTERMEDIATE_PAI
Intermediate result of ECC operation is 'at infinity' -not a real error.
Definition: pka.h:363
@ CC_ECC_PT_ADD
ECC point addition/doubling (complex arithmetic).
Definition: pka.h:322
uint16_t actual_len
Actual minimum # of bytes used by the operand.
Definition: pka.h:280
@ RC_ONE_EXPONENT
Exponent was 1 (for a modular exponentiation).
Definition: pka.h:355
int pka_mont_ecdh_mult(pka_handle_t handle, void *user_data, ecc_mont_curve_t *curve, pka_operand_t *point_x, pka_operand_t *multiplier)
@ RC_SHORT_MODULUS
Modulus was too short (less than 9 significant bits).
Definition: pka.h:353
pka_mont_curve_t type
type to depict curve.
Definition: pka.h:822
int pka_mont_ecdh(pka_handle_t handle, void *user_data, ecc_mont_curve_t *curve, pka_operand_t *point_x, pka_operand_t *private_key)
pka_operand_t s
big integer value called 's' in the standard
Definition: pka.h:1049
int pka_rsa_crt(pka_handle_t handle, void *user_data, pka_operand_t *p, pka_operand_t *q, pka_operand_t *c, pka_operand_t *d_p, pka_operand_t *d_q, pka_operand_t *qinv)
@ CC_DSA_GENERATE
DSA signature generation (high-level PKA operations).
Definition: pka.h:331
@ CC_COPY
Copy (basic arithmetic).
Definition: pka.h:312
void * user_data
Opaque data pointer.
Definition: pka.h:405
@ PKA_F_SYNC_MODE_ENABLE
Definition: pka.h:177
@ RC_COMPARE_EQUAL
Both operands are equal ('A' = 'B').
Definition: pka.h:392
pka_result_code_t
PKA Result Code Values.
Definition: pka.h:344
int pka_divide(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *divisor)
@ RC_UNDEFINED_TRIGGER
Host used undefined trigger.
Definition: pka.h:371
@ RC_OPERAND_VALUE_ERR
Operand value error.
Definition: pka.h:375
@ CC_SHIFT_RIGHT
Shift right (basic arithmetic).
Definition: pka.h:308
@ RC_INVALID_ARGUMENT
Invalid argument.
Definition: pka.h:373
int pka_ecdsa_signature_generate(pka_handle_t handle, void *user_data, ecc_curve_t *curve, ecc_point_t *base_pt, pka_operand_t *base_pt_order, pka_operand_t *private_key, pka_operand_t *hash, pka_operand_t *k)
int pka_ecdsa_signature_verify(pka_handle_t handle, void *user_data, ecc_curve_t *curve, ecc_point_t *base_pt, pka_operand_t *base_pt_order, ecc_point_t *public_key, pka_operand_t *hash, dsa_signature_t *rcvd_signature, uint8_t no_write)
uint32_t pka_request_count(pka_handle_t handle)
int pka_subtract(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *subtrahend)
uint16_t buf_len
Size of the buffer holding the big integer.
Definition: pka.h:279
@ PKA_CURVE_NULL
Definition: pka.h:796
@ CC_ECDSA_VERIFY
Definition: pka.h:329
@ RC_BAD_ODD_POWERS
Odd powers not in range 1 … 16.
Definition: pka.h:357
uint8_t internal_use
Internal use. Must be set to 0 by users.
Definition: pka.h:283
@ CC_ECC_PT_MULTIPLY
ECC point multiplication (complex arithmetic).
Definition: pka.h:324
pka_opcode_t
PKA Command Code Values.
Definition: pka.h:289
@ CC_DSA_VERIFY
Definition: pka.h:334
@ CC_MONT_ECDH_MULTIPLY
ECC point multiplication on Montgomery Curves (complex arithmetic)
Definition: pka.h:320
@ CC_MOD_EXP_CRT
Modular Exponentiation with CRT (complex arithmetic).
Definition: pka.h:316
uint8_t * buf_ptr
Pointer to the buffer holding the big integer.
Definition: pka.h:285
pka_opcode_t opcode
Opcode of the associated request.
Definition: pka.h:406
@ RC_TOO_LITTLE_MEMORY
Farm memory too small for operation.
Definition: pka.h:383
int pka_ecc_pt_mult(pka_handle_t handle, void *user_data, ecc_curve_t *curve, ecc_point_t *pointA, pka_operand_t *multiplier)
@ RC_RESULT_IS_PAI
Result point of ECC operation is 'at infinity' -not a real error.
Definition: pka.h:359
pka_mont_curve_t
Definition: pka.h:794
@ CC_ADD_SUBTRACT
Add/Subtract combination (basic arithmetic).
Definition: pka.h:296
int pka_modular_exp(pka_handle_t handle, void *user_data, pka_operand_t *exponent, pka_operand_t *modulus, pka_operand_t *value)
@ RC_MEMORY_DEADLOCK
Memory deadlock error.
Definition: pka.h:385
pka_operand_t A
coefficient of u^2 in the defining equation
Definition: pka.h:821
pka_operand_t b
constant coefficient in defining equation
Definition: pka.h:791
@ RC_RIGHT_IS_SMALLER
Right operand is smaller than left operand ('A' > 'B').
Definition: pka.h:396
uint64_t pka_instance_t
PK instance type.
Definition: pka.h:139
int pka_shift_right(pka_handle_t handle, void *user_data, pka_operand_t *value, uint32_t shift_cnt)
@ RC_ECC_RESULT_OFF_CURVE
Result of ECC operation is not on the curve.
Definition: pka.h:367
@ CC_MODULAR_EXP
Modular Exponentiation without CRT (complex arithmetic).
Definition: pka.h:314
@ RC_NO_MODULAR_INVERSE
Modular inverse does not exist.
Definition: pka.h:365
@ CC_DIVIDE
Divide (basic arithmetic).
Definition: pka.h:302
int pka_rsa(pka_handle_t handle, void *user_data, pka_operand_t *exponent, pka_operand_t *modulus, pka_operand_t *value)
pka_operand_t r
big integer value called 'r' in the standard
Definition: pka.h:1048
@ CC_COMPARE
Compare (basic arithmetic).
Definition: pka.h:310
uint8_t pka_get_rings_byte_order(pka_handle_t handle)
pka_operand_t p
large integer prime defining the finite field
Definition: pka.h:789
@ CC_DSA_VERIFY_NO_WRITE
Definition: pka.h:340
#define MAX_RESULT_CNT
Definition: pka.h:272
uint8_t is_encrypted
Reserved for future use.
Definition: pka.h:281
int pka_get_result(pka_handle_t handle, pka_results_t *results)
pka_flags_t
PK flags that are supplied during PK instance initialization.
Definition: pka.h:151
@ RC_LEFT_IS_SMALLER
Left operand is smaller than right operand ('A' < 'B').
Definition: pka.h:394
int pka_ecc_pt_add(pka_handle_t handle, void *user_data, ecc_curve_t *curve, ecc_point_t *pointA, ecc_point_t *pointB)
uint8_t result_cnt
Result cnt must be 0, 1 or 2.
Definition: pka.h:407
pka_operand_t p
large integer prime defining the finite field
Definition: pka.h:820
int pka_get_rand_bytes(pka_handle_t handle, uint8_t *buf, uint32_t buf_len)
int pka_dh(pka_handle_t handle, void *user_data, pka_operand_t *private_key, pka_operand_t *modulus, pka_operand_t *value)
bool pka_has_avail_result(pka_handle_t handle)
int pka_modulo(pka_handle_t handle, void *user_data, pka_operand_t *value, pka_operand_t *modulus)
int pka_ecdh(pka_handle_t handle, void *user_data, ecc_curve_t *curve, ecc_point_t *point, pka_operand_t *private_key)
@ CC_ADD
Add (basic arithmetic).
Definition: pka.h:292
uint8_t pad
Reserved for future use.
Definition: pka.h:284
@ PKA_F_PROCESS_MODE_SINGLE
Definition: pka.h:157
pka_handle_t pka_init_local(pka_instance_t instance)
@ RC_INVALID_ADDRESS
Address is invalid.
Definition: pka.h:379
uint32_t pka_get_rings_count(pka_instance_t instance)