/**
****************************************************************************************
*
* @file smp_common.h
*
* @brief Header file - Security Manager Protocol Common Definitions and Functions.
*
* Copyright (C) RivieraWaves 2009-2013
*
*
****************************************************************************************
*/

/**
 ****************************************************************************************
 * @addtogroup SMP_COMMON
 * @ingroup SMP
 * @{
 ****************************************************************************************
 */

#ifndef SMP_COMMON_H_
#define SMP_COMMON_H_

/*
 * INCLUDE FILES
 ****************************************************************************************
 */

#include "rwip_config.h"

#include "rwble_hl_config.h"

#include <stdbool.h>       // Standard Boolean Definitions
#include <stdint.h>        // Standard Integer Definitions

#include "co_utils.h"
#include "co_bt.h"         // Common Bluetooth Definitions

/*
 * DEFINES
 ****************************************************************************************
 */

/// Mask applied to a Pairing Failed error triggered by us.
#define SMP_PAIR_FAIL_REASON_MASK           (0x60)
/// Mask applied to a Pairing Failed error triggered by the peer device.
#define SMP_PAIR_FAIL_REASON_REM_MASK       (0x70)

/*
 * MACROS
 ****************************************************************************************
 */

/// Mask a Pairing Failed reason value with the provided mask.
#define SMP_GEN_PAIR_FAIL_REASON(mask, reason)  (mask | reason)
/// Extract the mask from a masked Pairing Failed reason value.
#define SMP_GET_PAIR_FAIL_MASK(reason)          (0xF0 & reason)
/// Extract the Pairing Failed reason value from a masked Pairing Failed reason value.
#define SMP_GET_PAIR_FAIL_REASON(reason)        (0x0F & reason)

/*
 * ENUMERATIONS
 ****************************************************************************************
 */

/**
 * SMP Pairing Failed Reasons
 */
enum smp_pair_fail_reason
{

    /**
     * Passkey Entry Failed (0x01)
     * The user input of passkey failed, for example, the user cancelled the operation.
     */
    SMP_ERROR_PASSKEY_ENTRY_FAILED      = 0x01,
    /**
     * OOB Not Available (0x02)
     * The OOB Data is not available.
     */
    SMP_ERROR_OOB_NOT_AVAILABLE,
    /**
     * Authentication Requirements (0x03)
     * The pairing procedure cannot be performed as authentication requirements cannot be
     * met due to IO capabilities of one or both devices.
     */
    SMP_ERROR_AUTH_REQ,
    /**
     * Confirm Value Failed (0x04)
     * The confirm value does not match the calculated confirm value.
     */
    SMP_ERROR_CONF_VAL_FAILED,
    /**
     * Pairing Not Supported (0x05)
     * Pairing is not supported by the device.
     */
    SMP_ERROR_PAIRING_NOT_SUPP,
    /**
     * Encryption Key Size (0x06)
     * The resultant encryption key size is insufficient for the security requirements of
     * this device.
     */
    SMP_ERROR_ENC_KEY_SIZE,
    /**
     * Command Not Supported (0x07)
     * The SMP command received is not supported on this device.
     */
    SMP_ERROR_CMD_NOT_SUPPORTED,
    /**
     * Unspecified Reason (0x08)
     * Pairing failed due to an unspecified reason.
     */
    SMP_ERROR_UNSPECIFIED_REASON,
    /**
     * Repeated Attempts (0x09)
     * Pairing or Authentication procedure is disallowed because too little time has elapsed
     * since last pairing request or security request.
     */
    SMP_ERROR_REPEATED_ATTEMPTS,
    /**
     * Invalid Parameters (0x0A)
     * The command length is invalid or a parameter is outside of the specified range.
     */
    SMP_ERROR_INVALID_PARAM,
};

/**
 * Proprietary SMP Error Codes
 */
enum smp_prop_error
{
    /**
     * No Error (0x00)
     * No error has occurred during the SMP procedure.
     */
    SMP_ERROR_NO_ERROR          = 0x00,
    /**
     * Request Disallowed (0x6B)
     * The request sent by the HL cannot be handled for some reasons (unauthorized source task,
     * role, ...)
     */
    SMP_ERROR_REQ_DISALLOWED    = ((SMP_PAIR_FAIL_REASON_MASK | SMP_ERROR_INVALID_PARAM) + 1),
    /**
     * Link Layer Error (0x6C)
     * An error has been received from the controller upon an encryption request.
     */
    SMP_ERROR_LL_ERROR,
    /**
     * Address Resolution Failed (0x6D)
     * The provided resolvable address has not been resolved.
     */
    SMP_ERROR_ADDR_RESOLV_FAIL,
    /**
     * Signature Verification Failed (0x6E)
     * The Signature Verification Failed
     */
    SMP_ERROR_SIGN_VERIF_FAIL,
    /**
     * Timeout (0x6F)
     * The command cannot be executed because a SMP timeout has been raised during the connection.
     */
    SMP_ERROR_TIMEOUT,
    /**
     * Encryption Key Missing (0x7B)
     * The encryption procedure failed because the slave device didn't find the LTK
     * needed to start an encryption session.
     */
    SMP_ERROR_ENC_KEY_MISSING   = ((SMP_PAIR_FAIL_REASON_REM_MASK | SMP_ERROR_INVALID_PARAM) + 1),
    /**
     * Encryption Not Supported (0x7C)
     * The encryption procedure failed because the slave device doesn't support the
     * encryption feature.
     */
    SMP_ERROR_ENC_NOT_SUPPORTED,
    /**
     * Encryption Request Timeout (0x7D)
     * A timeout has occurred during the start encryption session.
     */
    SMP_ERROR_ENC_TIMEOUT,
};

/*
 * STRUCTURES
 ****************************************************************************************
 */

/// Basic structure for a command request
struct smp_cmd
{
    uint8_t operation;

    /// More data, depends on the operation
};

#endif // (SMP_COMMON_H_)

/// @} SMP_COMMON