cgms_racp.h

Go to the documentation of this file.

/**
 ****************************************************************************************
 *
 * @file cgms_racp.h
 *
 * @brief Continuous Continuous Glucose Monitoring Monitoring Service Record Access Control Point API.
 *
 ****************************************************************************************
 * @attention
  #####Copyright (c) 2019 GOODIX
  All rights reserved.
 
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
  * Neither the name of GOODIX nor the names of its contributors may be used
    to endorse or promote products derived from this software without
    specific prior written permission.
 
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************************
 */
 
/**
 * @addtogroup BLE_SRV BLE Services
 * @{
 * @brief Definitions and prototypes for the BLE Service interface.
 */
 
/**
 * @defgroup BLE_SDK_CGMS_RACP Continuous Continuous Glucose Monitoring Monitoring Service Record Access Control Point (CGMS_RACP)
 * @{
 * @brief Continuous Continuous Glucose Monitoring Monitoring Service Record Access Control Point module.
 *
 * @details This module implements Continuous Glucose Monitoring Service Record Access Control Point (RACP), includeding
 *          parsing, executing and responsing RACP from Client.
 */
 
#ifndef __CGMS_RACP_H__
#define __CGMS_RACP_H__
 
/*
 * INCLUDE FILES
 ****************************************************************************************
 */
#include "gr_includes.h"
 
 
/**
 * @defgroup CGMS_RACP_MACRO Defines
 * @{
 */
#define CGMS_RACP_FILTER_TIME_OFFSET_LEN       2 
/** @} */
 
/**
 * @defgroup CGMS_RACP_ENUM Enumerations
 * @{
 */
/**@brief Continuous Glucose Monitoring Recoerd Access Control Point Operation Codes. */
typedef enum
{
    CGMS_RACP_OP_RESERVED,               /**< Reserved for future use. */
    CGMS_RACP_OP_REP_STRD_RECS,          /**< Report stored records (Operator: Value from Operator Table). */
    CGMS_RACP_OP_DEL_STRD_RECS,          /**< Delete stored records (Operator: Value from Operator Table). */
    CGMS_RACP_OP_ABORT_OP,               /**< Abort operation (Operator: Null 'value of 0x00 from Operator Table'). */
    CGMS_RACP_OP_REP_NB_OF_STRD_RECS,    /**< Report number of stored records (Operator: Value from Operator Table). */
    CGMS_RACP_OP_NB_OF_STRD_RECS_RSP,    /**< Number of stored records response (Operator: Null 'value of 0x00 from Operator Table'). */
    CGMS_RACP_OP_RSP_CODE,               /**< Response Code (Operator: Null 'value of 0x00 from Operator Table'). */
} cgms_racp_op_code_t;
 
/**@brief Continuous Glucose Monitoring Recoerd Access Control Point Operator. */
typedef enum
{
    CGMS_RACP_OPERATOR_NULL,             /**< NULL. */
    CGMS_RACP_OPERATOR_ALL_RECS,         /**< All records. */
    CGMS_RACP_OPERATOR_LE_OR_EQ,         /**< Less than or equal to. */
    CGMS_RACP_OPERATOR_GT_OR_EQ,         /**< Greater than or equal to. */
    CGMS_RACP_OPERATOR_WITHIN_RANGE_OF,  /**< Within rang of (inclusive). */
    CGMS_RACP_OPERATOR_FIRST_REC,        /**< First record(i.e. oldest record). */
    CGMS_RACP_OPERATOR_LAST_REC,         /**< Last record (i.e. most recent record). */
} cgms_racp_operator_t;
 
/**@brief Continuous Glucose Monitoring Recoerd Access Control Point Response codes. */
typedef enum
{
    CGMS_RACP_RSP_RESERVED,                  /**< Reserved for future use. */
    CGMS_RACP_RSP_SUCCESS,                   /**< Normal response for successful operation. */
    CGMS_RACP_RSP_OP_CODE_NOT_SUP,           /**< Normal response if unsupported Op Code is received. */
    CGMS_RACP_RSP_INVALID_OPERATOR,          /**< Normal response if Operator received does not meet the requirements of the service (e.g. Null was expected). */
    CGMS_RACP_RSP_OPERATOR_NOT_SUP,          /**< Normal response if unsupported Operator is received. */
    CGMS_RACP_RSP_INVALID_OPERAND,           /**< Normal response if Operand received does not meet the requirements of the service. */
    CGMS_RACP_RSP_NO_RECS_FOUND,             /**< Normal response if request to report stored records or request to delete stored records resulted in no records meeting criteria. */
    CGMS_RACP_RSP_ABORT_UNSUCCESSFUL,        /**< Normal response if request for Abort cannot be completed. */
    CGMS_RACP_RSP_PROCEDURE_NOT_COMPLETED,   /**< Normal response if unable to complete a procedure for any reason. */
    CGMS_RACP_RSP_OPERAND_NOT_SUP,           /**< Normal response if unsupported Operand is received. */
    CGMS_RACP_RSP_VALID_DECODE = 0xff        /**< User-defined response if RACP request is valid for CGMS. */
} cgms_racp_operand_t;
 
/**@brief Continuous Glucose Monitoring Recoerd Access Control Point filter types. */
typedef enum
{
    CGMS_RACP_FILTER_RESERVED,           /**< Reserved for future use. */
    CGMS_RACP_FILTER_TIME_OFFSET,
} cgms_racp_filter_type_t;
/** @} */
 
/**
 * @defgroup CGMS_RACP_STRUCT Structures
 * @{
 */
/**@brief Continuous Glucose Monitoring Recoerd Access Control Point request value. */
typedef struct
{
    cgms_racp_op_code_t     op_code;            /**< Continuous Glucose Monitoring Recoerd Access Control Point Operation Code. */
    cgms_racp_operator_t    operator;           /**< Continuous Glucose Monitoring Recoerd Access Control Point Operator. */
    cgms_racp_filter_type_t filter_type;        /**< Continuous Glucose Monitoring Recoerd Access Control Point filter types. */
    union
    {
        struct
        {
            uint16_t min;
            uint16_t max;
        } time_offset;
    } filter_param;                            /**< Filter param. */
} cgms_racp_req_t;
 
/**@brief Continuous Glucose Monitoring Recoerd Access Control Point response value. */
typedef struct
{
    cgms_racp_op_code_t   op_code;            /**< Continuous Glucose Monitoring Recoerd Access Control Point Operation Code. */
    cgms_racp_operator_t  operator;           /**< Continuous Glucose Monitoring Recoerd Access Control Point Operator. */
    union
    {
        uint16_t num_of_record;              /**< Number of record (if op_code = CGMS_RACP_OP_REP_NB_OF_STRD_RECS). */
        struct
        {
            cgms_racp_op_code_t op_code;    /**< Request Op Code. */
            cgms_racp_operand_t status;     /**< Command Status (if op_code = CGMS_RACP_OP_RSP_CODE). */
        } rsp;                               /**< Response. */
    } operand;                               /**< Response operand. */
} cgms_racp_rsp_t;
/** @} */
 
/**
 * @defgroup CGMS_RACP_FUNCTION Functions
 * @{
 */
/**
 *****************************************************************************************
 * @brief Decode record access control point request.
 *
 * @param[in]  p_data:     Pointer to data.
 * @param[in]  length:     Length of data.
 * @param[out] p_racp_req: Potnter to buffer saved decode result.
 *
 * @return Record access control point request decode result.
 *****************************************************************************************
 */
cgms_racp_operand_t cgms_racp_req_decode(const uint8_t *p_data, uint16_t length, cgms_racp_req_t *p_racp_req);
 
/**
 *****************************************************************************************
 * @brief Encode record access control point response.
 *
 * @param[in]  p_racp_rsp:       Pointer to buffer saved response.
 * @param[out] p_encoded_buffer: Pointer to buffer where the encoded data will be written.
 *
 * @return Length of encode data.
 *****************************************************************************************
 */
uint16_t cgms_racp_rsp_encode(cgms_racp_rsp_t *p_racp_rsp, uint8_t *p_encoded_buffer);
/** @} */
 
#endif
/** @} */
/** @} */