/** * \file * \brief HAL for kit protocol over HID for any platform. * * \copyright (c) 2015-2020 Microchip Technology Inc. and its subsidiaries. * * \page License * * Subject to your compliance with these terms, you may use Microchip software * and any derivatives exclusively with Microchip products. It is your * responsibility to comply with third party license terms applicable to your * use of third party software (including open source software) that may * accompany Microchip software. * * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A * PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, * SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE * OF ANY KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF * MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE * FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL * LIABILITY ON ALL CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED * THE AMOUNT OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR * THIS SOFTWARE. */ #include #include #include #include "hidapi.h" //#include "unistd.h" //#include #include "atca_hal.h" #include "hal_all_platforms_kit_hidapi.h" #include "hal/kit_protocol.h" /** \defgroup hal_ Hardware abstraction layer (hal_) * * \brief * These methods define the hardware abstraction layer for communicating with a CryptoAuth device * @{ */ // File scope globals atcahid_t _gHid; /** \brief discover cdc buses available for this hardware * this maintains a list of logical to physical bus mappings freeing the application * of the a-priori knowledge * \param[in] cdc_buses - an array of logical bus numbers * \param[in] max_buses - maximum number of buses the app wants to attempt to discover */ ATCA_STATUS hal_kit_hid_discover_buses(int i2c_buses[], int max_buses) { return ATCA_UNIMPLEMENTED; } /** \brief discover any CryptoAuth devices on a given logical bus number * \param[in] bus_num - logical bus number on which to look for CryptoAuth devices * \param[out] cfg[] - pointer to head of an array of interface config structures which get filled in by this method * \param[out] *found - number of devices found on this bus */ ATCA_STATUS hal_kit_hid_discover_devices(int bus_num, ATCAIfaceCfg cfg[], int *found) { return ATCA_UNIMPLEMENTED; } /** \brief HAL implementation of Kit USB HID init * \param[in] hal pointer to HAL specific data that is maintained by this HAL * \param[in] cfg pointer to HAL specific configuration data that is used to initialize this HAL * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_init(void* hal, ATCAIfaceCfg* cfg) { ATCAHAL_t *phal = (ATCAHAL_t*)hal; hid_device *handle; struct hid_device_info *devs = NULL; struct hid_device_info *cur_dev = NULL; int i = 0; int index = 0; // Check the input variables if ((cfg == NULL) || (phal == NULL)) { return ATCA_BAD_PARAM; } // Initialize the _gHid structure memset(&_gHid, 0, sizeof(_gHid)); for (i = 0; i < HID_DEVICES_MAX; i++) { _gHid.kits[i] = NULL; } _gHid.num_kits_found = 0; // Create the enumerate object #ifdef KIT_DEBUG printf("Enumerate HID device(s)\n"); #endif hid_init(); devs = hid_enumerate(cfg->atcahid.vid, cfg->atcahid.pid); cur_dev = devs; if (cur_dev == NULL) { #ifdef KIT_DEBUG printf("no HID device found\n"); #endif hid_exit(); return ATCA_COMM_FAIL; } while (cur_dev != NULL) { if ((handle = hid_open(cur_dev->vendor_id, cur_dev->product_id, cur_dev->serial_number))) { _gHid.kits[index] = handle; #ifdef KIT_DEBUG printf("Kit USB Device Node: %s\n", cur_dev->path); printf(" Manufacturer %s (%s)\n", (char*)cur_dev->manufacturer_string, (char*)cur_dev->product_string); printf(" PID %d\n", cur_dev->product_id); printf(" VID %d\n\n", cur_dev->vendor_id); #endif index++; } cur_dev = cur_dev->next; } hid_free_enumeration(devs); // Save the results of this discovery of HID if (index > 0) { _gHid.num_kits_found = index; phal->hal_data = &_gHid; } return ATCA_SUCCESS; } /** \brief HAL implementation of Kit HID post init * \param[in] iface instance * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_post_init(ATCAIface iface) { ATCA_STATUS status = ATCA_SUCCESS; atcahid_t* pHid = atgetifacehaldat(iface); ATCAIfaceCfg *pCfg = atgetifacecfg(iface); int i = 0; if ((pHid == NULL) || (pCfg == NULL)) { return ATCA_BAD_PARAM; } // Perform the kit protocol init for (i = 0; i < pHid->num_kits_found; i++) { status = kit_init(iface); if (status != ATCA_SUCCESS) #ifdef KIT_DEBUG { printf("kit_init() Failed"); } #endif { BREAK(status, "kit_init() failed"); } } return status; } /** \brief HAL implementation of send over USB HID * \param[in] iface instance * \param[in] txdata pointer to bytes to send * \param[in] txlength number of bytes to send * \return ATCA_STATUS */ ATCA_STATUS kit_phy_send(ATCAIface iface, uint8_t* txdata, int txlength) { ATCAIfaceCfg *cfg = atgetifacecfg(iface); atcahid_t* pHid = (atcahid_t*)atgetifacehaldat(iface); int bytes_written = 0; int bytes_left; int bytes_to_send; uint8_t buffer[HID_PACKET_MAX]; if ((txdata == NULL) || (cfg == NULL) || (pHid == NULL)) { return ATCA_BAD_PARAM; } if (pHid->kits[cfg->atcahid.idx] == NULL) { return ATCA_COMM_FAIL; } #ifdef KIT_DEBUG printf("HID layer: Write: %s", txdata); #endif //To avoid ERROR_INVALID_USER_BUFFER on Windows bytes_left = txlength; while (bytes_left > 0) { memset(buffer, 0, (HID_PACKET_MAX)); if (bytes_left >= cfg->atcahid.packetsize) { bytes_to_send = cfg->atcahid.packetsize; } else { bytes_to_send = bytes_left; } memcpy(&buffer[1], &txdata[(txlength - bytes_left)], bytes_to_send); bytes_written = hid_write(pHid->kits[cfg->atcahid.idx], buffer, cfg->atcahid.packetsize + 1); if (bytes_written != cfg->atcahid.packetsize + 1) { return ATCA_TX_FAIL; } bytes_left -= bytes_to_send; } return ATCA_SUCCESS; } /** \brief HAL implementation of kit protocol send over USB HID * \param[in] iface instance * \param[out] rxdata pointer to space to receive the data * \param[inout] rxsize ptr to expected number of receive bytes to request * \return ATCA_STATUS */ ATCA_STATUS kit_phy_receive(ATCAIface iface, uint8_t* rxdata, int* rxsize) { ATCAIfaceCfg *cfg = atgetifacecfg(iface); atcahid_t* pHid = (atcahid_t*)atgetifacehaldat(iface); bool continue_read = true; size_t bytes_read = 0; size_t total_bytes_read = 0; size_t bytes_to_read = *rxsize; char *location; if ((rxdata == NULL) || (rxsize == NULL) || (cfg == NULL) || (pHid == NULL)) { return ATCA_BAD_PARAM; } if (pHid->kits[cfg->atcahid.idx] == NULL) { return ATCA_COMM_FAIL; } bytes_to_read--; //hid_get_product_string(pHid->kits[cfg->atcahid.idx], &rxdata[total_bytes_read], bytes_to_read); //printf("%s\n", rxdata); // Receive the data from the kit USB device do { bytes_read = hid_read(pHid->kits[cfg->atcahid.idx], &rxdata[total_bytes_read], bytes_to_read); if (bytes_read == -1) { return ATCA_RX_FAIL; } total_bytes_read += bytes_read; bytes_to_read -= bytes_read; // Check if the kit protocol message has been received if (strstr((char*)rxdata, "\n") != NULL) { continue_read = false; } } while (continue_read == true); location = strchr((char*)rxdata, '\n'); // Save the total bytes read if (location != NULL) { *rxsize = (int)(location - (char*)rxdata); } else { *rxsize = (int)total_bytes_read; } #ifdef KIT_DEBUG printf("HID layer: Read: %s", rxdata); #endif // KIT_DEBUG return ATCA_SUCCESS; } /** \brief Number of USB HID devices found * \param[out] num_found * \return ATCA_STATUS */ ATCA_STATUS kit_phy_num_found(int8_t* num_found) { *num_found = _gHid.num_kits_found; return ATCA_SUCCESS; } /** \brief HAL implementation of kit protocol send over USB HID * \param[in] iface instance * \param[in] txdata pointer to bytes to send * \param[in] txlength number of bytes to send * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_send(ATCAIface iface, uint8_t* txdata, int txlength) { // Call the kit_send() function that will call phy_send() implemented below return kit_send(iface, txdata, txlength); } /** \brief HAL implementation of send over USB HID * \param[in] iface instance * \param[in] rxdata pointer to space to receive the data * \param[inout] rxsize ptr to expected number of receive bytes to request * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_receive(ATCAIface iface, uint8_t* rxdata, uint16_t* rxsize) { // Call the kit_receive() function that will call phy_receive() implemented below return kit_receive(iface, rxdata, rxsize); } /** \brief Call the wake for kit protocol * \param[in] iface ATCAIface instance that is the interface object to send the bytes over * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_wake(ATCAIface iface) { // Call the kit_wake() function that will call phy_send() and phy_receive() return kit_wake(iface); } /** \brief Call the idle for kit protocol * \param[in] iface ATCAIface instance that is the interface object to send the bytes over * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_idle(ATCAIface iface) { // Call the kit_idle() function that will call phy_send() and phy_receive() return kit_idle(iface); } /** \brief Call the sleep for kit protocol * \param[in] iface ATCAIface instance that is the interface object to send the bytes over * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_sleep(ATCAIface iface) { // Call the kit_sleep() function that will call phy_send() and phy_receive() return kit_sleep(iface); } /** \brief Close the physical port for HID * \param[in] hal_data The hardware abstraction data specific to this HAL * \return ATCA_STATUS */ ATCA_STATUS hal_kit_hid_release(void* hal_data) { atcahid_t* phaldat = (atcahid_t*)hal_data; int i = 0; if (phaldat == NULL) { return ATCA_BAD_PARAM; } // Close all kit USB devices for (i = 0; i < phaldat->num_kits_found; i++) { if (_gHid.kits[i] != NULL) { hid_close(_gHid.kits[i]); } } return ATCA_SUCCESS; } /** @} */