Mistake on this page?
Report an issue in GitHub or email us
lctr_api_adv_slave.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Link layer controller advertising slave interface file.
6  *
7  * Copyright (c) 2013-2018 Arm Ltd. All Rights Reserved.
8  *
9  * Copyright (c) 2019 Packetcraft, Inc.
10  *
11  * Licensed under the Apache License, Version 2.0 (the "License");
12  * you may not use this file except in compliance with the License.
13  * You may obtain a copy of the License at
14  *
15  * http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing, software
18  * distributed under the License is distributed on an "AS IS" BASIS,
19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20  * See the License for the specific language governing permissions and
21  * limitations under the License.
22  */
23 /*************************************************************************************************/
24 
25 #ifndef LCTR_API_ADV_SLAVE_H
26 #define LCTR_API_ADV_SLAVE_H
27 
28 #include "lctr_api.h"
29 #include "lmgr_api_adv_slave.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /*!
36  * \addtogroup LL_LCTR_API_ADV_SLV
37  * \{
38  */
39 
40 /**************************************************************************************************
41  Constants
42 **************************************************************************************************/
43 
44 /*! \brief Slave advertising task messages for \a LCTR_DISP_ADV dispatcher. */
45 enum
46 {
47  /* Broadcast events */
48  LCTR_ADV_MSG_RESET = LCTR_MSG_RESET, /*!< Reset API message. */
49  /* Advertising events */
50  LCTR_ADV_MSG_START, /*!< Advertising start API event. */
51  LCTR_ADV_MSG_STOP, /*!< Advertising stop API event. */
52  LCTR_ADV_MSG_INT_START, /*!< Advertising start internal event. */
53  LCTR_ADV_MSG_TERMINATE, /*!< Advertising BOD terminated event. */
54  LCTR_ADV_MSG_PARAM_UPD, /*!< Advertising parameter update event. */
55  LCTR_ADV_MSG_TOTAL /*!< Total number of advertising events. */
56 };
57 
58 /**************************************************************************************************
59  Data Types
60 **************************************************************************************************/
61 
62 /*! \brief Advertising parameter message. */
63 typedef struct
64 {
65  lctrMsgHdr_t hdr; /*!< Message header. */
66  lmgrAdvParam_t param; /*!< Advertising parameters. */
68 
69 /*! \brief Link layer controller advertising message data. */
70 typedef union
71 {
72  lctrMsgHdr_t hdr; /*!< Message header. */
73  lctrAdvParamMsg_t advParamUpd; /*!< Advertising parameter update. */
74 } LctrAdvMsg_t;
75 
76 /**************************************************************************************************
77  Function Declarations
78 **************************************************************************************************/
79 
80 /* Initialization */
81 void LctrSlvAdvInit(void);
82 void LctrSlvAdvDefaults(void);
83 
84 /*! \} */ /* LL_LCTR_API_ADV_SLV */
85 
86 #ifdef __cplusplus
87 };
88 #endif
89 
90 #endif /* LCTR_API_ADV_SLAVE_H */
Advertising parameter message.
Link layer manager advertising slave interface file.
Advertising parameters.
lctrAdvParamMsg_t advParamUpd
Link layer controller common interface file.
lctrMsgHdr_t hdr
Common message structure passed to event handler.
Definition: lctr_api.h:109
lmgrAdvParam_t param
Link layer controller advertising message data.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.