Mistake on this page?
Report an issue in GitHub or email us
lctr_api_init_master_ae.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Link layer controller extended initiating master interface file.
6  *
7  * Copyright (c) 2013-2019 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_INIT_MASTER_AE_H
26 #define LCTR_API_INIT_MASTER_AE_H
27 
28 #include "lctr_api.h"
29 #include "wsf_assert.h"
30 #include "lctr_api_init_master.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /*!
37  * \addtogroup LL_LCTR_API_INIT_MST_AE
38  * \{
39  */
40 
41 /**************************************************************************************************
42  Constants
43 **************************************************************************************************/
44 
45 /*! \brief Master extended initiate task messages for \a LCTR_DISP_EXT_INIT dispatcher. */
46 enum
47 {
48  /* Broadcast events */
49  LCTR_EXT_INIT_MSG_RESET = LCTR_MSG_RESET, /*!< Reset API message. */
50  /* Initiate events */
51  LCTR_EXT_INIT_MSG_INITIATE, /*!< Initiate API event. */
52  LCTR_EXT_INIT_MSG_INITIATE_CANCEL, /*!< Initiate cancel API event. */
53  LCTR_EXT_INIT_MSG_TERMINATE, /*!< Initiate scan BOD terminated event. */
54  LCTR_EXT_INIT_MSG_TOTAL /*!< Total number of initiate events. */
55 };
56 
57 /*! \brief LCTR_EXT_INIT_MSG_INITIATE_CANCEL and LCTR_INIT_MSG_INITIATE_CANCEL shall be aligned. */
59 
60 /**************************************************************************************************
61  Data Types
62 **************************************************************************************************/
63 
64 /**************************************************************************************************
65  Function Declarations
66 **************************************************************************************************/
67 
68 /* Initialization */
69 void LctrMstExtInitInit(void);
70 void LctrMstExtInitDefaults(void);
71 
72 /* Control */
73 void LctrMstExtInitParam(uint8_t initPhy, const LlExtInitScanParam_t *pScanParam, const LlConnSpec_t *pConnSpec);
74 void LctrMstExtInitSetScanPhy(uint8_t scanPhy);
75 void LctrMstExtInitClearScanPhy(uint8_t scanPhy);
76 
77 /* Utility */
78 bool_t LctrMstExtInitIsEnabled(uint8_t scanPhy);
79 bool_t LctrMstExtInitIsPrivAddr(uint8_t scanPhy);
80 
81 /*! \} */ /* LL_LCTR_API_INIT_MST_AE */
82 
83 #ifdef __cplusplus
84 };
85 #endif
86 
87 #endif /* LCTR_API_INIT_MASTER_AE_H */
WSF_CT_ASSERT(((int) LCTR_EXT_INIT_MSG_INITIATE_CANCEL==(int) LCTR_INIT_MSG_INITIATE_CANCEL))
LCTR_EXT_INIT_MSG_INITIATE_CANCEL and LCTR_INIT_MSG_INITIATE_CANCEL shall be aligned.
Initiating scan parameters (LlExtCreateConn()).
Definition: ll_api.h:617
Link layer controller common interface file.
Assert macro.
Link layer controller initiating master interface file.
Connection specification (LlCreateConn(), LlConnUpdate() and LlExtCreateConn()).
Definition: ll_api.h:624
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.