wiced_bt_anp.h

/*
 * Copyright 2016-2024, 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.
 */


/**************************************************************************//**
*
* \file
*
* \brief Provides common definitions of the Alert Notification Server(ANS)
*        and Alert Notification Client(ANC).
*
******************************************************************************/

#ifndef WICED_BT_ANP_H
#define WICED_BT_ANP_H
#include "wiced_bt_types.h"

/**************************************************************************//**
*
* \anchor ANP_ALERT_CATEGORY_ID
* \name Alert category ID.
*
* @{
******************************************************************************/
#define ANP_ALERT_CATEGORY_ID_SIMPLE_ALERT          0
#define ANP_ALERT_CATEGORY_ID_EMAIL                 1
#define ANP_ALERT_CATEGORY_ID_NEWS                  2
#define ANP_ALERT_CATEGORY_ID_CALL                  3
#define ANP_ALERT_CATEGORY_ID_MISSED_CALL           4
#define ANP_ALERT_CATEGORY_ID_SMS_OR_MMS            5
#define ANP_ALERT_CATEGORY_ID_VOICE_MAIL            6
#define ANP_ALERT_CATEGORY_ID_SCHEDULE_ALERT        7
#define ANP_ALERT_CATEGORY_ID_HIGH_PRI_ALERT        8
#define ANP_ALERT_CATEGORY_ID_INSTANT_MESSAGE       9

#define ANP_NOTIFY_CATEGORY_COUNT                   (ANP_ALERT_CATEGORY_ID_INSTANT_MESSAGE + 1)

#define ANP_ALERT_CATEGORY_ID_ALL_CONFIGURED        0xff /* A special value used only by the Alert notification client in the notify immedietely control
                                                            point GATT write operation. This enables the client to receive missing alerts
                                                            quickly during a connection loss recovery. */
typedef uint8_t wiced_bt_anp_alert_category_id_t;
/** @} ANP_ALERT_CATEGORY_ID */

/**************************************************************************//**
*
* \anchor ANP_ALERT_CATEGORY_ENABLE
* \name The Alert category enable bit mask.
*
* @{
*
******************************************************************************/
#define ANP_ALERT_CATEGORY_ENABLE_SIMPLE_ALERT          ( 1 << ANP_ALERT_CATEGORY_ID_SIMPLE_ALERT)
#define ANP_ALERT_CATEGORY_ENABLE_EMAIL                 ( 1 << ANP_ALERT_CATEGORY_ID_EMAIL)
#define ANP_ALERT_CATEGORY_ENABLE_NEWS                  ( 1 << ANP_ALERT_CATEGORY_ID_NEWS)
#define ANP_ALERT_CATEGORY_ENABLE_CALL                  ( 1 << ANP_ALERT_CATEGORY_ID_CALL)
#define ANP_ALERT_CATEGORY_ENABLE_MISSED_CALL           ( 1 << ANP_ALERT_CATEGORY_ID_MISSED_CALL)
#define ANP_ALERT_CATEGORY_ENABLE_SMS_OR_MMS            ( 1 << ANP_ALERT_CATEGORY_ID_SMS_OR_MMS)
#define ANP_ALERT_CATEGORY_ENABLE_VOICE_MAIL            ( 1 << ANP_ALERT_CATEGORY_ID_VOICE_MAIL)
#define ANP_ALERT_CATEGORY_ENABLE_SCHEDULE_ALERT        ( 1 << ANP_ALERT_CATEGORY_ID_SCHEDULE_ALERT)
#define ANP_ALERT_CATEGORY_ENABLE_HIGH_PRI_ALERT        ( 1 << ANP_ALERT_CATEGORY_ID_HIGH_PRI_ALERT)
#define ANP_ALERT_CATEGORY_ENABLE_INSTANT_MESSAGE       ( 1 << ANP_ALERT_CATEGORY_ID_INSTANT_MESSAGE)
typedef uint16_t wiced_bt_anp_alert_category_enable_t;
/** @} ANP_ALERT_CATEGORY_ENABLE */


/**************************************************************************//**
*
* \anchor ANP_ALERT_CONTROL_CMD
* \name Alert control commands
*
* @{
*
******************************************************************************/
#define ANP_ALERT_CONTROL_CMD_ENABLE_NEW_ALERTS                    0
#define ANP_ALERT_CONTROL_CMD_ENABLE_UNREAD_STATUS                 1
#define ANP_ALERT_CONTROL_CMD_DISABLE_NEW_ALERTS                   2
#define ANP_ALERT_CONTROL_CMD_DISABLE_UNREAD_ALERTS                3
#define ANP_ALERT_CONTROL_CMD_NOTIFY_NEW_ALERTS_IMMEDIATE          4
#define ANP_ALERT_CONTROL_CMD_NOTIFY_UNREAD_ALERTS_IMMEDIATE       5
typedef uint8_t wiced_bt_anp_alert_control_cmd_id_t;
/** @} ANP_ALERT_CONTROL_CMD */


#define ANP_ALERT_NOTIFCATION_CONTROL_POINT_WRITE_CMD_NOT_SUPPORTED      0xA0

#endif /* WICED_BT_ANP_H */