123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665 |
- #ifndef __GZP_H
- #define __GZP_H
- #include "nrf.h"
- #include "nrf_gzp_config.h"
- #include <stdbool.h>
- #ifdef __cplusplus
- extern "C" {
- #endif
- #define GZP_PAIRING_PIPE 0
- #define GZP_DATA_PIPE 1
- #define GZP_TX_RX_TRANS_DELAY 10
- #define GZP_SYSTEM_ADDRESS_WIDTH 4
- #define GZP_VALIDATION_ID {0x32, 0x53, 0x66}
- #define GZP_VALIDATION_ID_LENGTH 3
- #define GZP_HOST_ID_LENGTH 5
- #define GZP_SESSION_TOKEN_LENGTH GZP_HOST_ID_LENGTH
- #define GZP_DYN_KEY_LENGTH (16 - GZP_VALIDATION_ID_LENGTH)
- #define GZP_HOST_RX_POWER_THRESHOLD -64
- #define GZP_CMD_HOST_ADDRESS_REQ_PAYLOAD_LENGTH 1
- #define GZP_CMD_HOST_ADDRESS_FETCH_PAYLOAD_LENGTH 1
- #define GZP_CMD_HOST_ID_REQ_SESSION_TOKEN 1
- #define GZP_CMD_HOST_ID_REQ_PAYLOAD_LENGTH (GZP_CMD_HOST_ID_REQ_SESSION_TOKEN + GZP_SESSION_TOKEN_LENGTH)
- #if (GZP_CMD_HOST_ID_REQ_PAYLOAD_LENGTH > 17)
- #error GZP_SESSION_TOKEN_LENGTH too long.
- #endif
- #define GZP_CMD_HOST_ID_FETCH_VALIDATION_ID 1
- #define GZP_CMD_HOST_ID_FETCH_PAYLOAD_LENGTH (GZP_CMD_HOST_ID_FETCH_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)
- #if (GZP_CMD_HOST_ID_FETCH_PAYLOAD_LENGTH > 17)
- #error GZP_VALIDATION_ID_LENGTH set too long.
- #endif
- #define GZP_CMD_KEY_UPDATE_PREPARE_PAYLOAD_LENGTH 1
- #define GZP_CMD_KEY_UPDATE_VALIDATION_ID 1
- #define GZP_CMD_KEY_UPDATE_NEW_KEY (GZP_CMD_KEY_UPDATE_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)
- #define GZP_CMD_KEY_UPDATE_PAYLOAD_LENGTH (GZP_CMD_KEY_UPDATE_NEW_KEY + GZP_DYN_KEY_LENGTH)
- #if (GZP_CMD_KEY_UPDATE_PAYLOAD_LENGTH > 17)
- #error Sum (GZP_VALIDATION_ID_LENGTH + GZP_DYN_KEY_LENGTH) too high.
- #endif
- #define GZP_CMD_ENCRYPTED_USER_DATA_VALIDATION_ID 1
- #define GZP_CMD_ENCRYPTED_USER_DATA_PAYLOAD ((GZP_CMD_ENCRYPTED_USER_DATA_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH))
- #define GZP_ENCRYPTED_USER_DATA_PACKET_OVERHEAD ( GZP_CMD_ENCRYPTED_USER_DATA_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)
- #define GZP_ENCRYPTED_USER_DATA_MAX_LENGTH (17 - GZP_ENCRYPTED_USER_DATA_PACKET_OVERHEAD)
- #if (GZP_MAX_FW_PAYLOAD_LENGTH < 17)
- #error GZP_MAX_FW_PAYLOAD_LENGTH must be greater or equal to 17.
- #endif
- #define GZP_CMD_FETCH_RESP_PAYLOAD_LENGTH 1
- #define GZP_CMD_HOST_ADDRESS_RESP_ADDRESS 1
- #define GZP_CMD_HOST_ADDRESS_RESP_PAYLOAD_LENGTH (GZP_CMD_HOST_ADDRESS_RESP_ADDRESS + GZP_SYSTEM_ADDRESS_WIDTH)
- #if (GZP_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_HOST_ADDRESS_RESP_PAYLOAD_LENGTH)
- #error GZP_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_HOST_ADDRESS_RESP_PAYLOAD_LENGTH.
- #endif
- #define GZP_CMD_HOST_ID_FETCH_RESP_VALIDATION_ID 1
- #define GZP_CMD_HOST_ID_FETCH_RESP_STATUS (GZP_CMD_HOST_ID_FETCH_RESP_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)
- #define GZP_CMD_HOST_ID_FETCH_RESP_HOST_ID (GZP_CMD_HOST_ID_FETCH_RESP_STATUS + 1)
- #define GZP_CMD_HOST_ID_FETCH_RESP_PAYLOAD_LENGTH (GZP_CMD_HOST_ID_FETCH_RESP_HOST_ID + GZP_HOST_ID_LENGTH)
- #if (GZP_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_HOST_ID_FETCH_RESP_PAYLOAD_LENGTH)
- #error GZP_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_HOST_ID_FETCH_RESP_PAYLOAD_LENGTH.
- #endif
- #define GZP_CMD_KEY_UPDATE_PREPARE_RESP_SESSION_TOKEN 1
- #define GZP_CMD_KEY_UPDATE_PREPARE_RESP_PAYLOAD_LENGTH (GZP_CMD_KEY_UPDATE_PREPARE_RESP_SESSION_TOKEN + GZP_SESSION_TOKEN_LENGTH)
- #if (GZP_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_KEY_UPDATE_PREPARE_RESP_PAYLOAD_LENGTH)
- #error GZP_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_KEY_UPDATE_PREPARE_RESP_PAYLOAD_LENGTH.
- #endif
- #define GZP_CMD_ENCRYPTED_USER_DATA_RESP_SESSION_TOKEN 1
- #define GZP_CMD_ENCRYPTED_USER_DATA_RESP_VALIDATION_ID (GZP_CMD_ENCRYPTED_USER_DATA_RESP_SESSION_TOKEN + GZP_SESSION_TOKEN_LENGTH)
- #define GZP_CMD_ENCRYPTED_USER_DATA_RESP_PAYLOAD_LENGTH (GZP_CMD_ENCRYPTED_USER_DATA_RESP_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)
- #if (GZP_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_ENCRYPTED_USER_DATA_RESP_PAYLOAD_LENGTH)
- #error GZP_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_ENCRYPTED_USER_DATA_RESP_PAYLOAD_LENGTH.
- #endif
- #if (GZP_VALIDATION_ID_LENGTH > GZP_HOST_ID_LENGTH)
- #error GZP_HOST_ID_LENGTH should be greater or equal to GZP_VALIDATION_ID_LENGTH.
- #endif
- #if (GZP_SESSION_TOKEN_LENGTH != GZP_HOST_ID_LENGTH)
- #error GZP_SESSION_TOKEN_LENGTH must equal GZP_HOST_ID_LENGTH.
- #endif
- #ifdef GZLL_CRYPT_ENABLE
- #error Gazell encryption can not be enabled when using the Gazell pairing library. \
- GZLL_CRYPT_ENABLE must be undefined.
- #endif
- typedef enum
- {
- GZP_ID_EXCHANGE,
- GZP_KEY_EXCHANGE,
- GZP_DATA_EXCHANGE
- } gzp_key_select_t;
- typedef enum
- {
- GZP_CMD_HOST_ADDRESS_REQ = 0,
- GZP_CMD_HOST_ADDRESS_FETCH,
- GZP_CMD_HOST_ID_REQ,
- GZP_CMD_HOST_ID_FETCH,
- GZP_CMD_KEY_UPDATE_PREPARE,
- GZP_CMD_KEY_UPDATE,
- GZP_CMD_ENCRYPTED_USER_DATA,
- GZP_CMD_FETCH_RESP,
- GZP_CMD_HOST_ADDRESS_RESP,
- GZP_CMD_HOST_ID_FETCH_RESP,
- GZP_CMD_KEY_UPDATE_PREPARE_RESP,
- GZP_CMD_ENCRYPTED_USER_DATA_RESP,
- } gzp_cmd_t;
- typedef enum
- {
- GZP_ID_RESP_PENDING,
- GZP_ID_RESP_GRANTED,
- GZP_ID_RESP_REJECTED,
- GZP_ID_RESP_FAILED,
- GZP_ID_RESP_NO_REQUEST
- } gzp_id_req_res_t;
- void gzp_crypt_set_session_token(const uint8_t *token);
- void gzp_crypt_get_session_token(uint8_t *dst_token);
- void gzp_crypt_set_dyn_key(const uint8_t* dyn_key);
- void gzp_crypt_get_dyn_key(uint8_t *dst_key);
- static void gzp_set_host_id(const uint8_t* src);
- void gzp_get_host_id(uint8_t *dst);
- void gzp_crypt_select_key(gzp_key_select_t key_select);
- void gzp_crypt(uint8_t* dst, const uint8_t* src, uint8_t length);
- bool gzp_validate_id(const uint8_t *src_id);
- void gzp_add_validation_id(uint8_t *dst_id);
- void gzp_random_numbers_generate(uint8_t *dst, uint8_t n);
- bool gzp_update_radio_params(const uint8_t *system_address);
- void gzp_generate_channels(uint8_t *ch_dst, const uint8_t * address, uint8_t channel_set_size);
- void gzp_xor_cipher(uint8_t* dst, const uint8_t* src, const uint8_t* pad, uint8_t length);
- void gzp_init(void);
- void gzp_erase_pairing_data(void);
- void nrf_gzp_disable_gzll(void);
- void gzp_id_req_cancel(void);
- void nrf_gzp_flush_rx_fifo(uint32_t pipe);
- bool nrf_gzp_tx_complete(void);
- bool nrf_gzp_tx_success(void);
- void nrf_gzp_reset_tx_complete(void);
- void nrf_gzp_reset_tx_success(void);
- int8_t gzp_get_pairing_status(void);
- bool gzp_address_req_send(void);
- gzp_id_req_res_t gzp_id_req_send(void);
- bool gzp_crypt_data_send(const uint8_t *src, uint8_t length);
- void gzp_pairing_enable(bool enable);
- void gzp_host_execute(void);
- bool gzp_address_exchanged(void);
- bool gzp_id_req_received(void);
- void gzp_id_req_reject(void);
- void gzp_id_req_grant(void);
- bool gzp_crypt_user_data_received(void);
- bool gzp_crypt_user_data_read(uint8_t* dst, uint8_t* length);
- void gzll_rx_start(void);
- #ifdef __cplusplus
- }
- #endif
- #endif
|