/* SPDX-License-Identifier: GPL-2.0 */ /* * Copyright (c) 2017, Microchip Technology Inc. * Author: Tudor Ambarus */ #ifndef __ATMEL_I2C_H__ #define __ATMEL_I2C_H__ #include <linux/hw_random.h> #include <linux/types.h> #define ATMEL_ECC_PRIORITY … #define COMMAND … #define SLEEP_TOKEN … #define WAKE_TOKEN_MAX_SIZE … /* Definitions of Data and Command sizes */ #define WORD_ADDR_SIZE … #define COUNT_SIZE … #define CRC_SIZE … #define CMD_OVERHEAD_SIZE … /* size in bytes of the n prime */ #define ATMEL_ECC_NIST_P256_N_SIZE … #define ATMEL_ECC_PUBKEY_SIZE … #define STATUS_RSP_SIZE … #define ECDH_RSP_SIZE … #define GENKEY_RSP_SIZE … #define READ_RSP_SIZE … #define RANDOM_RSP_SIZE … #define MAX_RSP_SIZE … /** * atmel_i2c_cmd - structure used for communicating with the device. * @word_addr: indicates the function of the packet sent to the device. This * byte should have a value of COMMAND for normal operation. * @count : number of bytes to be transferred to (or from) the device. * @opcode : the command code. * @param1 : the first parameter; always present. * @param2 : the second parameter; always present. * @data : optional remaining input data. Includes a 2-byte CRC. * @rxsize : size of the data received from i2c client. * @msecs : command execution time in milliseconds */ struct atmel_i2c_cmd { … } __packed; /* Status/Error codes */ #define STATUS_SIZE … #define STATUS_NOERR … #define STATUS_WAKE_SUCCESSFUL … /* Definitions for eeprom organization */ #define CONFIGURATION_ZONE … #define OTP_ZONE … /* Definitions for eeprom zone sizes */ #define OTP_ZONE_SIZE … /* Definitions for Indexes common to all commands */ #define RSP_DATA_IDX … #define DATA_SLOT_2 … /* Definitions for the device lock state */ #define DEVICE_LOCK_ADDR … #define LOCK_VALUE_IDX … #define LOCK_CONFIG_IDX … /* * Wake High delay to data communication (microseconds). SDA should be stable * high for this entire duration. */ #define TWHI_MIN … #define TWHI_MAX … /* Wake Low duration */ #define TWLO_USEC … /* Command execution time (milliseconds) */ #define MAX_EXEC_TIME_ECDH … #define MAX_EXEC_TIME_GENKEY … #define MAX_EXEC_TIME_READ … #define MAX_EXEC_TIME_RANDOM … /* Command opcode */ #define OPCODE_ECDH … #define OPCODE_GENKEY … #define OPCODE_READ … #define OPCODE_RANDOM … /* Definitions for the READ Command */ #define READ_COUNT … /* Definitions for the RANDOM Command */ #define RANDOM_COUNT … /* Definitions for the GenKey Command */ #define GENKEY_COUNT … #define GENKEY_MODE_PRIVATE … /* Definitions for the ECDH Command */ #define ECDH_COUNT … #define ECDH_PREFIX_MODE … /* Used for binding tfm objects to i2c clients. */ struct atmel_ecc_driver_data { … } ____cacheline_aligned; /** * atmel_i2c_client_priv - i2c_client private data * @client : pointer to i2c client device * @i2c_client_list_node: part of i2c_client_list * @lock : lock for sending i2c commands * @wake_token : wake token array of zeros * @wake_token_sz : size in bytes of the wake_token * @tfm_count : number of active crypto transformations on i2c client * @hwrng : hold the hardware generated rng * * Reads and writes from/to the i2c client are sequential. The first byte * transmitted to the device is treated as the byte size. Any attempt to send * more than this number of bytes will cause the device to not ACK those bytes. * After the host writes a single command byte to the input buffer, reads are * prohibited until after the device completes command execution. Use a mutex * when sending i2c commands. */ struct atmel_i2c_client_priv { … }; /** * atmel_i2c_work_data - data structure representing the work * @ctx : transformation context. * @cbk : pointer to a callback function to be invoked upon completion of this * request. This has the form: * callback(struct atmel_i2c_work_data *work_data, void *areq, u8 status) * where: * @work_data: data structure representing the work * @areq : optional pointer to an argument passed with the original * request. * @status : status returned from the i2c client device or i2c error. * @areq: optional pointer to a user argument for use at callback time. * @work: describes the task to be executed. * @cmd : structure used for communicating with the device. */ struct atmel_i2c_work_data { … }; int atmel_i2c_probe(struct i2c_client *client); void atmel_i2c_enqueue(struct atmel_i2c_work_data *work_data, void (*cbk)(struct atmel_i2c_work_data *work_data, void *areq, int status), void *areq); void atmel_i2c_flush_queue(void); int atmel_i2c_send_receive(struct i2c_client *client, struct atmel_i2c_cmd *cmd); void atmel_i2c_init_read_config_cmd(struct atmel_i2c_cmd *cmd); int atmel_i2c_init_read_otp_cmd(struct atmel_i2c_cmd *cmd, u16 addr); void atmel_i2c_init_random_cmd(struct atmel_i2c_cmd *cmd); void atmel_i2c_init_genkey_cmd(struct atmel_i2c_cmd *cmd, u16 keyid); int atmel_i2c_init_ecdh_cmd(struct atmel_i2c_cmd *cmd, struct scatterlist *pubkey); #endif /* __ATMEL_I2C_H__ */