Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Macros | Typedefs | Enumerations | Functions
lctr_int_adv_master_ae.h File Reference

Internal link layer controller extended scanning master interface file. More...

#include "lctr_int_adv_ae.h"
#include "lctr_int.h"
#include "lctr_api_adv_master_ae.h"
#include "lctr_int_adv_master.h"
#include "lctr_pdu_adv_ae.h"
#include "bb_ble_api.h"
#include "ll_defs.h"
#include "wsf_timer.h"

Go to the source code of this file.

Data Structures

struct  lctrExtScanCtx_t
 Extended scanning context. More...
 
struct  lctrExtScanCtrlBlk_t
 Extended scanning control block. More...
 
struct  lctrActiveExtScan_t
 Active extended scanning context. More...
 
struct  lctrPerScanCtx_t
 Periodic scanning context. More...
 
struct  lctrPerCreateSyncCtrlBlk_t
 Master scan state context. More...
 
struct  lctrAcadMsgHdr_t
 ACAD message header. More...
 
union  lctrAcadMsg_t
 ACAD message generic type. More...
 
struct  lctrPerTransferSyncCtrlBlk_t
 Periodic sync transfer state context. More...
 

Macros

#define LCTR_GET_EXT_SCAN_HANDLE(pCtx)   (pCtx->handle)
 Resolve the extended scan handle from the context pointer. More...
 
#define LCTR_GET_EXT_SCAN_CTX(h)    (lctrMstExtScanTbl[h])
 Resolve the extended scan context from the handle. More...
 
#define LCTR_GET_PER_SCAN_HANDLE(pCtx)   (pCtx - lctrMstPerScanTbl)
 Resolve the periodic scanning handle from the context pointer. More...
 
#define LCTR_GET_PER_SCAN_TM_HANDLE(pCtx)   (LL_MAX_CONN + LCTR_GET_PER_SCAN_HANDLE(pCtx))
 Get topology manager handle from the periodic scanning context pointer. More...
 
#define LCTR_GET_PER_SCAN_CTX(h)    (&lctrMstPerScanTbl[h])
 Resolve the periodic scanning context from the handle. More...
 
#define LCTR_VALID_ACTIVE_SCAN_MASK   ((1 << LCTR_SCAN_PHY_1M) | (1 << LCTR_SCAN_PHY_CODED))
 Valid active scan mask. More...
 

Typedefs

typedef void(* lctrTermHdlr_t) (uint16_t syncHandle)
 Termination event handler call signature. More...
 

Enumerations

Functions

static uint8_t lctrConvertAuxPtrPhyToAdvRptPhy (uint8_t auxPtrPhy)
 Convert PHY value to PHY value in extended advertising report. More...
 
static uint8_t lctrConvertAuxPtrPhyToBbPhy (uint8_t auxPtrPhy)
 Convert AuxPtr PHY value to PHY value in extended advertising report. More...
 
static void lctrMstComputeAuxOffset (lctrAuxPtr_t *pAuxPtr, uint32_t *pOffsetUsec, uint32_t *pSyncDelayUsec)
 Compute auxiliary offset. More...
 

Detailed Description

Internal link layer controller extended scanning master interface file.

Copyright (c) 2013-2019 Arm Ltd. All Rights Reserved.

Copyright (c) 2019-2020 Packetcraft, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file lctr_int_adv_master_ae.h.

Macro Definition Documentation

#define LCTR_GET_EXT_SCAN_CTX (   h)    (lctrMstExtScanTbl[h])

Resolve the extended scan context from the handle.

Definition at line 49 of file lctr_int_adv_master_ae.h.

#define LCTR_GET_EXT_SCAN_HANDLE (   pCtx)    (pCtx->handle)

Resolve the extended scan handle from the context pointer.

Definition at line 46 of file lctr_int_adv_master_ae.h.

#define LCTR_GET_PER_SCAN_CTX (   h)    (&lctrMstPerScanTbl[h])

Resolve the periodic scanning context from the handle.

Definition at line 58 of file lctr_int_adv_master_ae.h.

#define LCTR_GET_PER_SCAN_HANDLE (   pCtx)    (pCtx - lctrMstPerScanTbl)

Resolve the periodic scanning handle from the context pointer.

Definition at line 52 of file lctr_int_adv_master_ae.h.

#define LCTR_GET_PER_SCAN_TM_HANDLE (   pCtx)    (LL_MAX_CONN + LCTR_GET_PER_SCAN_HANDLE(pCtx))

Get topology manager handle from the periodic scanning context pointer.

Definition at line 55 of file lctr_int_adv_master_ae.h.

#define LCTR_VALID_ACTIVE_SCAN_MASK   ((1 << LCTR_SCAN_PHY_1M) | (1 << LCTR_SCAN_PHY_CODED))

Valid active scan mask.

Definition at line 61 of file lctr_int_adv_master_ae.h.

Typedef Documentation

typedef void(* lctrTermHdlr_t) (uint16_t syncHandle)

Termination event handler call signature.

Definition at line 225 of file lctr_int_adv_master_ae.h.

Enumeration Type Documentation

anonymous enum

Master scan states.

Enumerator
LCTR_EXT_SCAN_STATE_DISABLED 

Scan disabled state.

LCTR_EXT_SCAN_STATE_DISCOVER 

Scan enabled state.

LCTR_EXT_SCAN_STATE_SHUTDOWN 

Scan shutdown in progress.

LCTR_EXT_SCAN_STATE_RESET 

Scan reset in progress.

LCTR_EXT_SCAN_STATE_TOTAL 

Total number of scan states.

Definition at line 68 of file lctr_int_adv_master_ae.h.

anonymous enum

Create sync states.

Enumerator
LCTR_CREATE_SYNC_STATE_DISABLED 

Create sync disabled state.

LCTR_CREATE_SYNC_STATE_DISCOVER 

Create sync enabled state.

LCTR_CREATE_SYNC_STATE_SHUTDOWN 

Create sync shutdown in process state.

LCTR_CREATE_SYNC_STATE_RESET 

Create sync reset in progress.

LCTR_CREATE_SYNC_STATE_TOTAL 

Total number of Create sync states.

Definition at line 78 of file lctr_int_adv_master_ae.h.

anonymous enum

Transfer sync states.

Enumerator
LCTR_TRANSFER_SYNC_STATE_DISABLED 

Transfer sync disabled state.

LCTR_TRANSFER_SYNC_STATE_DISCOVER 

Transfer sync enabled state.

LCTR_TRANSFER_SYNC_STATE_SHUTDOWN 

Transfer sync shutdown in process state.

LCTR_TRANSFER_SYNC_STATE_RESET 

Transfer sync reset in progress.

LCTR_TRANSFER_SYNC_STATE_TOTAL 

Total number of Transfer sync states.

Definition at line 88 of file lctr_int_adv_master_ae.h.

anonymous enum

Periodic scanning states.

Enumerator
LCTR_PER_SCAN_STATE_DISABLE 

Periodic scanning disabled state.

LCTR_PER_SCAN_STATE_SYNC_ESTD 

Periodic scanning sync established state.

LCTR_PER_SCAN_STATE_SYNC_TERMINATE 

Periodic scanning sync terminate in process state.

LCTR_PER_SCAN_STATE_RESET 

Periodic scanning sync reset in progress.

LCTR_PER_SCAN_STATE_TOTAL 

Total number of Periodic scanning states.

Definition at line 98 of file lctr_int_adv_master_ae.h.

anonymous enum

Internal common (non-context, non-broadcast) events.

Enumerator
LCTR_EXT_SCAN_MSG_TMR_DUR_EXP 

Duration timer expired event.

LCTR_EXT_SCAN_MSG_TMR_PER_EXP 

Period timer expired event.

Definition at line 108 of file lctr_int_adv_master_ae.h.

Extended advertising report assembly state.

Enumerator
LCTR_RPT_STATE_IDLE 

No report assembly in progress.

LCTR_RPT_STATE_IN_PROGRESS 

Report assembly in progress.

LCTR_RPT_STATE_COMP 

Report assembly completed.

Definition at line 116 of file lctr_int_adv_master_ae.h.

Function Documentation

static uint8_t lctrConvertAuxPtrPhyToAdvRptPhy ( uint8_t  auxPtrPhy)
static

Convert PHY value to PHY value in extended advertising report.

Parameters
auxPtrPhyAuxiliary Pointer PHY field.
Returns
LL PHY value.

Definition at line 427 of file lctr_int_adv_master_ae.h.

static uint8_t lctrConvertAuxPtrPhyToBbPhy ( uint8_t  auxPtrPhy)
static

Convert AuxPtr PHY value to PHY value in extended advertising report.

Parameters
auxPtrPhyAuxiliary Pointer PHY field.
Returns
BB PHY value.

Definition at line 450 of file lctr_int_adv_master_ae.h.

static void lctrMstComputeAuxOffset ( lctrAuxPtr_t pAuxPtr,
uint32_t *  pOffsetUsec,
uint32_t *  pSyncDelayUsec 
)
static

Compute auxiliary offset.

Parameters
pAuxPtrAuxiliary Pointer.
pOffsetUsecReturn auxiliary offset in microseconds.
pSyncDelayUsecReturn synchronization delay in microseconds.

Definition at line 473 of file lctr_int_adv_master_ae.h.

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.