app_bt_bonding.c

/******************************************************************************
* File Name:   app_bt_bonding.c
*
* Description: This is the source code for bonding implementation using kv-store
*              library for the Peripheral_Privacy Example for ModusToolbox.
*
* Related Document: See README.md
*
*******************************************************************************
* Copyright 2021-2023, Cypress Semiconductor Corporation (an Infineon company) or
* an affiliate of Cypress Semiconductor Corporation.  All rights reserved.
*
* This software, including source code, documentation and related
* materials ("Software") is owned by Cypress Semiconductor Corporation
* or one of its affiliates ("Cypress") and is protected by and subject to
* worldwide patent protection (United States and foreign),
* United States copyright laws and international treaty provisions.
* Therefore, you may use this Software only as provided in the license
* agreement accompanying the software package from which you
* obtained this Software ("EULA").
* If no EULA applies, Cypress hereby grants you a personal, non-exclusive,
* non-transferable license to copy, modify, and compile the Software
* source code solely for use in connection with Cypress's
* integrated circuit products.  Any reproduction, modification, translation,
* compilation, or representation of this Software except as specified
* above is prohibited without the express written permission of Cypress.
*
* Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Cypress
* reserves the right to make changes to the Software without notice. Cypress
* does not assume any liability arising out of the application or use of the
* Software or any product or circuit described in the Software. Cypress does
* not authorize its products for use in any products where a malfunction or
* failure of the Cypress product may reasonably be expected to result in
* significant property damage, injury or death ("High Risk Product"). By
* including Cypress's product in a High Risk Product, the manufacturer
* of such system or application assumes all risk of such use and in doing
* so agrees to indemnify Cypress against all liability.
*******************************************************************************/

/*******************************************************************************
*        Header Files
*******************************************************************************/
#include "wiced_bt_stack.h"
#include "cybsp.h"
#include "cyhal.h"
#include "cy_retarget_io.h"

#include "cycfg_bt_settings.h"

#include "peripheral_privacy.h"
#include "app_bt_bonding.h"
#include "mtb_kvstore_cat5.h"
#include "app_utils.h"
#include "app_bt_bonding.h"
#include "stdlib.h"
#include <inttypes.h>


/*******************************************************************
 * Variable Definitions
 ******************************************************************/
/*Kvstore block device*/

mtb_kvstore_t  kvstore_obj;



bond_info_t    bondinfo;
wiced_bt_local_identity_keys_t identity_keys;
uint16_t       peer_cccd_data[BOND_INDEX_MAX];

/*******************************************************************************
 *                              FUNCTION DEFINITIONS
 ******************************************************************************/

/**
* Function Name:
* app_kv_store_init
*
* Function Description:
* @brief   This function initializes the SMIF and kv-store library
*
* @param   None
*
* @return  None
*/

void app_kv_store_init(void)
{
    cy_rslt_t rslt;

    /*Initialize kv-store library*/
    rslt = mtb_kvstore_init(&kvstore_obj);
    /*Check if the kv-store initialization was successful*/
    if (CY_RSLT_SUCCESS != rslt)
    {
        printf("failed to initialize kv-store \n");
        CY_ASSERT(0);
    }
}

/**
* Function Name:
* print_device_selection_menu
*
* Function Description:
* @brief   This function prints device selection menu for user input
*
* @param   None
*
* @return  None
*/
void print_device_selection_menu(void)
{
    for (uint8_t i = 0; i < bondinfo.slot_data[NUM_BONDED]; i++)
    {
        printf("Host %d: ", i + 1);
        print_bd_address(bondinfo.link_keys[i].bd_addr);
    }
}

/**
* Function Name:
* app_bt_restore_bond_data
*
* Function Description:
* @brief  This function restores the bond information from the Flash
*
* @param   None
*
* @return  cy_rslt_t: CY_RSLT_SUCCESS if the restoration was successful,
*                         an error code otherwise.
*
*/
cy_rslt_t app_bt_restore_bond_data(void)
{
    /* Read and restore contents of Serial flash */
    uint32_t data_size = sizeof(bondinfo);
    cy_rslt_t rslt = mtb_kvstore_read_numeric_key(&kvstore_obj, bond_data, NULL, NULL);
    if (rslt != CY_RSLT_SUCCESS)
    {
        printf("Bond data not present in the flash!\n");
    }
    else
    {
        rslt = mtb_kvstore_read_numeric_key(&kvstore_obj, bond_data, (uint8_t *)&bondinfo, &data_size);
    }

    return rslt;
}

/**
* Function Name:
* app_bt_update_slot_data
*
* Function Description:
* @brief  This function updates the slot data in the Flash
*
* @param  None
*
* @return cy_rslt_t: CY_RSLT_SUCCESS if the update was successful,
*              an error code otherwise.
*/
cy_rslt_t app_bt_update_slot_data(void)
{
    cy_rslt_t rslt = CY_RSLT_TYPE_ERROR;
    /* Increment number of bonded devices and next free slot and save them in Flash */
    if ( BOND_INDEX_MAX > bondinfo.slot_data[NUM_BONDED])
    {
        /* Increment only if the bonded devices are less than BOND_INDEX_MAX */
        bondinfo.slot_data[NUM_BONDED]++;
    }
    /* Update Next Slot to be used for next incoming Device */
    bondinfo.slot_data[NEXT_FREE_INDEX] = (bondinfo.slot_data[NEXT_FREE_INDEX] + 1) % BOND_INDEX_MAX;
    rslt = app_bt_update_bond_data();
    return rslt;
}

/**
* Function Name:
* app_bt_update_cccd
*
* Function Description:
* @brief  This function updates the CCCD data in the Flash
*
* @param  cccd: cccd value to be updated in flash
* @param  index: Index of the device in the flash
*
* @return cy_rslt_t: CY_RSLT_SUCCESS if the update was successful,
*              an error code otherwise.
*/
cy_rslt_t app_bt_update_cccd(uint16_t cccd, uint8_t index)
{
        cy_rslt_t rslt = CY_RSLT_TYPE_ERROR;
        peer_cccd_data[index]= cccd;
        printf("Updating CCCD Value to: %d \r\n",cccd);
        rslt = mtb_kvstore_write_numeric_key(&kvstore_obj, cccd_data, (uint8_t *)&peer_cccd_data, sizeof(peer_cccd_data),true);
        return rslt;
}

/**
* Function Name:
* app_bt_restore_cccd
*
* Function Description:
* @brief This function restores the cccd from the Flash
*
* @param   None
*
* @return  cy_rslt_t: CY_RSLT_SUCCESS if the update was successful,
*              an error code otherwise.
*
**/
cy_rslt_t app_bt_restore_cccd(void)
{
    cy_rslt_t rslt = CY_RSLT_TYPE_ERROR;
    uint32_t data_size = sizeof(peer_cccd_data);
    rslt = mtb_kvstore_read_numeric_key(&kvstore_obj, cccd_data, (uint8_t *)peer_cccd_data, &data_size);
    return rslt;
}

/**
* Function Name:
* app_bt_update_bond_data
*
* Function Description:
* @brief This function updates the bond information in the Flash
*
* @param   None
*
* @return  cy_rslt_t: CY_RSLT_SUCCESS if the update was successful,
*              an error code otherwise.
*
**/
cy_rslt_t app_bt_update_bond_data(void)
{
    cy_rslt_t rslt = CY_RSLT_TYPE_ERROR;
    rslt = mtb_kvstore_write_numeric_key(&kvstore_obj, bond_data, (uint8_t *)&bondinfo, sizeof(bondinfo),true);
    if (CY_RSLT_SUCCESS != rslt)
    {
        printf("Flash Write Error,Error code: %" PRIu32 "\r\n", rslt );
    }

    return rslt;
}

/**
* Function Name:
* app_bt_delete_bond_info
*
* Function Description:
* @brief  This deletes the bond information from the Flash
*
* @param  None
*
* @return  cy_rslt_t: CY_RSLT_SUCCESS if the deletion was successful,
*              an error code otherwise.
*
*/
cy_rslt_t app_bt_delete_bond_info(void)
{
    cy_rslt_t rslt = CY_RSLT_SUCCESS;

    for (uint8_t i = 0; i < bondinfo.slot_data[NUM_BONDED]; i++)
    {
       wiced_result_t result = app_bt_delete_device_info(i);
       if (WICED_BT_SUCCESS != result)
       {
           rslt = CY_RSLT_TYPE_ERROR;
           return rslt;
       }
    }

    /*Update the slot data*/
    bondinfo.slot_data[NUM_BONDED]=0;
    bondinfo.slot_data[NEXT_FREE_INDEX]=0;

    /*Update bond information*/
    rslt = app_bt_update_bond_data();
    return rslt;
}

/**
* Function Name:
* app_bt_delete_device_info
*
* Function Description:
* @brief  This function deletes the bond information of the device from the RAM
*         and address resolution database.
*
* @param  index: Index of the device whose data is to be deleted
*
* @return  wiced_result_t: WICED_BT_SUCCESS if the deletion was successful,
*                   an error code otherwise.
*
*/
wiced_result_t app_bt_delete_device_info(uint8_t index)
{
    wiced_result_t result = WICED_BT_SUCCESS;
    /* Remove from the bonded device list */
    result = wiced_bt_dev_delete_bonded_device(bondinfo.link_keys[index].bd_addr);
    if(WICED_BT_SUCCESS != result)
    {
        return result;
    }
    /* Remove device from address resolution database */
    result = wiced_bt_dev_remove_device_from_address_resolution_db(&(bondinfo.link_keys[index]));
    if (WICED_BT_SUCCESS != result)
    {
        return result;
    }

    /* Remove bonding information in RAM */
    peer_cccd_data[index]=0;
    bondinfo.privacy_mode[index]=0;
    memset(&bondinfo.link_keys[index], 0, sizeof(wiced_bt_device_link_keys_t));

    return result;
}

/**
* Function Name:
* app_bt_save_device_link_keys
*
* Function Description:
* @brief This function saves peer device link keys to the Flash
*
* @param link_key: Save link keys of the peer device.
*
* @return cy_rslt_t: CY_RSLT_SUCCESS if the save was successful,
*              an error code otherwise.
*
*/
cy_rslt_t app_bt_save_device_link_keys(wiced_bt_device_link_keys_t *link_key)
{
    cy_rslt_t rslt = CY_RSLT_TYPE_ERROR;
    memcpy(&bondinfo.link_keys[bondinfo.slot_data[NEXT_FREE_INDEX]],
           (uint8_t *)(link_key), sizeof(wiced_bt_device_link_keys_t));

    rslt = mtb_kvstore_write_numeric_key(&kvstore_obj, bond_data, (uint8_t *)&bondinfo, sizeof(bondinfo),true);
    if (CY_RSLT_SUCCESS != rslt)
    {
        printf("Flash Write Error,Error code: %" PRIu32 "\r\n", rslt );
    }
    return rslt;
}

/**
* Function Name:
* app_bt_find_device_in_flash
*
* Function Description:
* @brief This function searches provided bd_addr in bonded devices list
*
* @param *bd_addr: pointer to the address of the device to be searched
*
* @return uint8_t: Index of the device in the bond data stored in the flash if found,
*            else returns  BOND_INDEX_MAX to indicate the device was not found.
*
*/
uint8_t app_bt_find_device_in_flash(uint8_t *bd_addr)
{
    uint8_t index =  BOND_INDEX_MAX; /*Return out of range value if device is not found*/
    for (uint8_t count = 0; count < bondinfo.slot_data[NUM_BONDED]; count++)
    {
        if (0 == memcmp(&(bondinfo.link_keys[count].bd_addr), bd_addr, sizeof(wiced_bt_device_address_t)))
        {
            printf("Found device in the flash!\n");
            index = count;
            break; /* Exit the loop since we found what we want */
        }
    }
    return(index);
}

/**
* Function Name:
* app_bt_read_local_identity_keys
*
* Function Description:
* @brief This function saves local device identity keys to the Flash
*
* @param None
*
* @return cy_rslt_t: CY_RSLT_SUCCESS if the read was successful,
*              an error code otherwise.
*
*/
cy_rslt_t app_bt_read_local_identity_keys(void)
{
    uint32_t data_size = sizeof(identity_keys);
    cy_rslt_t rslt = mtb_kvstore_read_numeric_key(&kvstore_obj, local_irk, NULL, NULL);
    if (rslt != CY_RSLT_SUCCESS)
    {
        printf("Error Reading Keys! New Keys need to be generated! \r\n");
    }
    else
    {
        printf("Identity keys are available in the database.\r\n");
        rslt = mtb_kvstore_read_numeric_key(&kvstore_obj, local_irk, (uint8_t *)&identity_keys, &data_size);
        printf("Local identity keys read from Flash: \r\n");
    }
    return rslt;
}
/**
* Function Name:
* app_bt_save_local_identity_key
*
* Function Description:
* @briefThis function saves local device identity keys to the Flash
*
* @param id_key: Local identity keys to store in the flash.
*
* @return cy_rslt_t: CY_RSLT_SUCCESS if the save was successful,
*              an error code otherwise.
*
*/
cy_rslt_t app_bt_save_local_identity_key(wiced_bt_local_identity_keys_t id_key)
{
    memcpy(&identity_keys, (uint8_t *)&(id_key), sizeof(wiced_bt_local_identity_keys_t));
    cy_rslt_t rslt = mtb_kvstore_write_numeric_key(&kvstore_obj, local_irk, (uint8_t *)&identity_keys, sizeof(wiced_bt_local_identity_keys_t),true);
    if (CY_RSLT_SUCCESS == rslt)
    {
        printf("Local identity Keys saved to Flash \r\n");
    }
    else
    {
        printf("Flash Write Error,Error code: %" PRIu32 "\r\n", rslt );
    }

    return rslt;
}

/**
* Function Name:
* app_bt_add_devices_to_address_resolution_db
*
* Function Description:
* @brief This function adds the bonded devices to address resolution database
*
* @param  None
*
* @return None
*
*/
void app_bt_add_devices_to_address_resolution_db(void)
{
    /* Copy in the keys and add them to the address resolution database */
    for (uint8_t i = 0; (i < bondinfo.slot_data[NUM_BONDED]) && (i < BOND_INDEX_MAX); i++)
    {
        /* Add device to address resolution database */
        wiced_result_t result = wiced_bt_dev_add_device_to_address_resolution_db(&bondinfo.link_keys[i]);
        if (WICED_BT_SUCCESS == result)
        {
            printf("Device added to address resolution database: ");
            print_bd_address((uint8_t *)&bondinfo.link_keys[i].bd_addr);
        }
        else
        {
            printf("Error adding device to address resolution database, Error Code %d \n", result);
        }
    }
}

/**
* Function Name:
* print_bond_data
*
* Function Description:
* @brief This function prints the bond data stored in the Flash
*
* @param None
*
* @return None
*
*/
void print_bond_data()
{
    for (uint8_t i = 0; i < bondinfo.slot_data[NUM_BONDED] && i< BOND_INDEX_MAX; i++)
    {
        printf("Slot: %d",i+1);
        printf("Device Bluetooth Address: ");
        print_bd_address(bondinfo.link_keys[i].bd_addr);
        printf("Device Keys: \n");
        print_array(&(bondinfo.link_keys[i].key_data), sizeof(wiced_bt_device_sec_keys_t));
        printf("\n");
    }
}