Cordio Stack and Cordio Profiles  r2p3-02rel0
svc_alert.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Example Alert-related service implementation.
6  *
7  * Copyright (c) 2011-2018 Arm Ltd. All Rights Reserved.
8  * Arm Ltd. confidential and proprietary.
9  *
10  * IMPORTANT. Your use of this file is governed by a Software License Agreement
11  * ("Agreement") that must be accepted in order to download or otherwise receive a
12  * copy of this file. You may not use or copy this file for any purpose other than
13  * as described in the Agreement. If you do not agree to all of the terms of the
14  * Agreement do not use this file and delete all copies in your possession or control;
15  * if you do not have a copy of the Agreement, you must contact Arm Ltd. prior
16  * to any use, copying or further distribution of this software.
17  */
18 /*************************************************************************************************/
19 
20 #ifndef SVC_ALERT_H
21 #define SVC_ALERT_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /*! \addtogroup ALERT-RELATED_SERVICE
28  * \{ */
29 
30 /**************************************************************************************************
31  Handle Ranges
32 **************************************************************************************************/
33 
34 /** \name Alert Handles
35  *
36  */
37 /**@{*/
38 #define ALERT_START_HDL 0xA0 /*!< \brief Start handle. */
39 #define ALERT_END_HDL (ALERT_MAX_HDL - 1) /*!< \brief End handle. */
40 
41 /**************************************************************************************************
42  Handles
43 **************************************************************************************************/
44 
45 /*! \brief Alert-Related Service Handles */
46 enum
47 {
48  ALERT_ANS_SVC_HDL = ALERT_START_HDL, /*!< \brief Alert notification service declaration */
49  ALERT_ANS_SNA_CH_HDL, /*!< \brief Supported new alert category characteristic */
50  ALERT_ANS_SNA_HDL, /*!< \brief Supported new alert category */
51  ALERT_ANS_NEW_CH_HDL, /*!< \brief New alert characteristic */
52  ALERT_ANS_NEW_HDL, /*!< \brief New alert */
53  ALERT_ANS_NEW_CH_CCC_HDL, /*!< \brief New alert client characteristic configuration */
54  ALERT_ANS_UNR_CH_HDL, /*!< \brief Supported unread alert category characteristic */
55  ALERT_ANS_UNR_HDL, /*!< \brief Supported unread alert category */
56  ALERT_ANS_UAS_CH_HDL, /*!< \brief Unread alert status characteristic */
57  ALERT_ANS_UAS_HDL, /*!< \brief Unread alert status */
58  ALERT_ANS_UAS_CH_CCC_HDL, /*!< \brief Unread alert status client characteristic configuration */
59  ALERT_ANS_CP_CH_HDL, /*!< \brief Alert notification control point characteristic */
60  ALERT_ANS_CP_HDL, /*!< \brief Alert notification control point */
61 
62  ALERT_PASS_SVC_HDL, /*!< \brief Phone alert status service declaration */
63  ALERT_PASS_AS_CH_HDL, /*!< \brief Alert status characteristic */
64  ALERT_PASS_AS_HDL, /*!< \brief Alert status */
65  ALERT_PASS_AS_CCC_HDL, /*!< \brief Alert status client characteristic configuration */
66  ALERT_PASS_RS_CH_HDL, /*!< \brief Ringer setting characteristic */
67  ALERT_PASS_RS_HDL, /*!< \brief Ringer setting */
68  ALERT_PASS_RS_CCC_HDL, /*!< \brief Ringer settting client characteristic configuration */
69  ALERT_PASS_RCP_CH_HDL, /*!< \brief Ringer control point characteristic */
70  ALERT_PASS_RCP_HDL, /*!< \brief Ringer control point */
71 
72  ALERT_NWS_SVC_HDL, /*!< \brief Network availability service declaration */
73  ALERT_NWS_NWA_CH_HDL, /*!< \brief Network availability characteristic */
74  ALERT_NWS_NWA_HDL, /*!< \brief Network availability */
75  ALERT_NWS_NWA_CH_CCC_HDL, /*!< \brief Network availability client characteristic configuration */
76  ALERT_MAX_HDL /*!< \brief Maximum handle. */
77 };
78 
79 /**@}*/
80 
81 /**************************************************************************************************
82  Function Declarations
83 **************************************************************************************************/
84 
85 /*************************************************************************************************/
86 /*!
87  * \brief Add the services to the attribute server.
88  *
89  * \return None.
90  */
91 /*************************************************************************************************/
92 void SvcAlertAddGroup(void);
93 
94 /*************************************************************************************************/
95 /*!
96  * \brief Remove the services from the attribute server.
97  *
98  * \return None.
99  */
100 /*************************************************************************************************/
101 void SvcAlertRemoveGroup(void);
102 
103 /*! \} */ /* ALERT-RELATED_SERVICE */
104 
105 #ifdef __cplusplus
106 };
107 #endif
108 
109 #endif /* SVC_ALERT_H */
110 
Network availability characteristic.
Definition: svc_alert.h:73
Ringer setting characteristic.
Definition: svc_alert.h:66
Ringer setting.
Definition: svc_alert.h:67
Network availability.
Definition: svc_alert.h:74
Alert status client characteristic configuration.
Definition: svc_alert.h:65
New alert client characteristic configuration.
Definition: svc_alert.h:53
Supported new alert category characteristic.
Definition: svc_alert.h:49
Phone alert status service declaration.
Definition: svc_alert.h:62
Network availability service declaration.
Definition: svc_alert.h:72
New alert.
Definition: svc_alert.h:52
New alert characteristic.
Definition: svc_alert.h:51
Supported unread alert category.
Definition: svc_alert.h:55
Supported unread alert category characteristic.
Definition: svc_alert.h:54
Ringer control point.
Definition: svc_alert.h:70
Unread alert status client characteristic configuration.
Definition: svc_alert.h:58
Network availability client characteristic configuration.
Definition: svc_alert.h:75
Alert notification service declaration.
Definition: svc_alert.h:48
Alert status.
Definition: svc_alert.h:64
Alert notification control point.
Definition: svc_alert.h:60
Supported new alert category.
Definition: svc_alert.h:50
Unread alert status characteristic.
Definition: svc_alert.h:56
void SvcAlertRemoveGroup(void)
Remove the services from the attribute server.
void SvcAlertAddGroup(void)
Add the services to the attribute server.
Alert notification control point characteristic.
Definition: svc_alert.h:59
#define ALERT_START_HDL
Start handle.
Definition: svc_alert.h:38
Ringer settting client characteristic configuration.
Definition: svc_alert.h:68
Ringer control point characteristic.
Definition: svc_alert.h:69
Maximum handle.
Definition: svc_alert.h:76
Unread alert status.
Definition: svc_alert.h:57
Alert status characteristic.
Definition: svc_alert.h:63