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

Baseband interface file. More...

#include "wsf_types.h"
#include "cfg_mac.h"
#include "pal_bb.h"

Go to the source code of this file.

Data Structures

struct  BbRtCfg_t
 BB runtime configuration parameters. More...
 
struct  BbOpDesc_tag
 Baseband operation descriptor (BOD). More...
 

Typedefs

typedef void(* BbBodCompCback_t) (void)
 BOD completion event callback signature. More...
 
typedef void(* BbBodCback_t) (struct BbOpDesc_tag *pBod)
 BOD event callback signature. More...
 
typedef void(* BbProtCback_t) (void)
 Protocol event callback signature. More...
 
typedef void(* BbLowPowerCback_t) (void)
 Low power callback. More...
 
typedef struct BbOpDesc_tag BbOpDesc_t
 Baseband operation descriptor (BOD). More...
 

Enumerations

Functions

void BbInitRunTimeCfg (const BbRtCfg_t *pCfg)
 Initialize runtime configuration. More...
 
void BbInit (void)
 Initialize the BB. More...
 
void BbRegister (BbBodCompCback_t eventCback)
 Register operation completion handler. More...
 
void BbRegisterProt (PalBbProt_t protId, BbBodCback_t execOpCback, BbBodCback_t cancelOpCback, BbProtCback_t startProtCback, BbProtCback_t stopProtCback)
 Register protocol handlers. More...
 
void BbRegisterProtLowPower (PalBbProt_t protId, BbLowPowerCback_t lowPowerOpCback)
 Register protocol handlers for low power. More...
 
void BbStart (PalBbProt_t protId)
 Start BB processing of given protocol. More...
 
void BbStop (PalBbProt_t protId)
 Stop BB processing of given protocol. More...
 
void BbExecuteBod (BbOpDesc_t *pBod)
 Execute BOD. More...
 
void BbCancelBod (void)
 Cancel current executing BOD. More...
 
BbOpDesc_tBbGetCurrentBod (void)
 Get the currently-executing BOD. More...
 
void BbSetBodTerminateFlag (void)
 Set termination flag of current executing BOD. More...
 
bool_t BbGetBodTerminateFlag (void)
 Get termination state of current executing BOD. More...
 
void BbTerminateBod (void)
 Terminate a BOD immediately. More...
 
uint16_t BbGetClockAccuracy (void)
 Get BB clock accuracy. More...
 
uint32_t BbGetBbTimerBoundaryUs (void)
 Get BB timer boundary before wraparound. More...
 
uint16_t BbGetSchSetupDelayUs (void)
 Get scheduler setup delay. More...
 
uint32_t BbAdjustTime (uint32_t dueUsec)
 Adjust new time tick with wraparound. More...
 
uint32_t BbGetTargetTimeDelta (uint32_t targetUsec, uint32_t refUsec)
 Get Delta between target and reference time. Only valid if target time is in the future. More...
 
uint8_t BbGetActiveProtocol (void)
 Returns the ID of the active protocol. More...
 

Detailed Description

Baseband interface file.

Copyright (c) 2013-2018 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 bb_api.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.