Mbed OS Reference | bb_ble_api_pdufilt.h Source File

Go to the documentation of this file.
 /*************************************************************************************************/
 /*!
  *  \file
  *
  *  \brief      BLE baseband PDU filtering interface file.
  *
  *  Copyright (c) 2016-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.
  */
 /*************************************************************************************************/
 
 #ifndef BB_BLE_API_PDUFILT_H
 #define BB_BLE_API_PDUFILT_H
 
 #include "wsf_types.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /*! \addtogroup BB_API_BLE_PDU_FILT
  *  \{ */
 
 /**************************************************************************************************
   Data Types
 **************************************************************************************************/
 
 /*! \brief      Check whether a flag is set. */
 #define BB_BLE_PDU_FILT_FLAG_IS_SET(pFilt, flag)   (((pFilt)->flags & BB_BLE_PDU_FILT_FLAG_##flag) != 0)
 
 /*! \brief      Set a flag. */
 #define BB_BLE_PDU_FILT_SET_FLAG(pFilt, flag)        (pFilt)->flags |= BB_BLE_PDU_FILT_FLAG_##flag;
 
 /*! \brief      PDU filtering flags. */
 enum
 {
   /* Common flags. */
   BB_BLE_PDU_FILT_FLAG_LOCAL_ADDR_MATCH_ENA  = (1 << 0),    /*!< Local address should be matched. */
   BB_BLE_PDU_FILT_FLAG_LOCAL_ADDR_MATCH_RAND = (1 << 1),    /*!< Local address to match is a random address. */
   BB_BLE_PDU_FILT_FLAG_PEER_ADDR_MATCH_ENA   = (1 << 2),    /*!< Peer address should be matched. */
   BB_BLE_PDU_FILT_FLAG_PEER_ADDR_MATCH_RAND  = (1 << 3),    /*!< Peer address to match is a random address. */
 
   /* Privacy flags. */
   BB_BLE_PDU_FILT_FLAG_LOCAL_ADDR_RES_ENA    = (1 << 4),    /*!< Local address resolution is enabled. */
   BB_BLE_PDU_FILT_FLAG_LOCAL_ADDR_RES_OPT    = (1 << 5),    /*!< Local address resolution is optional. */
   BB_BLE_PDU_FILT_FLAG_PEER_ADDR_RES_ENA     = (1 << 6),    /*!< Peer address resolution is enabled. */
 };
 
 /*! \brief      Periodic PDU filtering parameters. */
 typedef struct
 {
   uint8_t       filterPolicy;         /*!< Filter policy. */
   uint8_t       advSID;               /*!< Advertising SID. */
   uint8_t       advAddrType;          /*!< Advertiser Address Type. */
   uint64_t      advAddr;              /*!< Advertiser Address. */
 } bbBlePerPduFiltParams_t;
 
 /*! \brief      PDU filtering parameters. */
 typedef struct
 {
   uint16_t      pduTypeFilt;          /*!< Bit map of the PDUs the BB should allow. */
   uint16_t      wlPduTypeFilt;        /*!< Bit map of the PDUs the BB should pass through the whitelist. */
   uint32_t      flags;                /*!< Flags for PDU filtering. */
   uint64_t      localAddrMatch;       /*!< Local address to match. */
   uint64_t      peerAddrMatch;        /*!< Peer address to match. */
 } bbBlePduFiltParams_t;
 
 /*! \brief      Extended PDU filtering parameters. */
 typedef struct
 {
   uint64_t      peerAddr;             /*!< Peer address. */
   uint64_t      localAddr;            /*!< Local address. */
   uint8_t       pduType;              /*!< PDU type. */
   uint8_t       extHdrFlags;          /*!< Extended header flags. */
   bool_t        peerAddrRand;         /*!< TRUE if peer address is random, FALSE otherwise. */
   bool_t        localAddrRand;        /*!< TRUE if local address is random, FALSE otherwise. */
 } bbBlePduExtFiltParams_t;
 
 /*! \brief      PDU filtering results. */
 typedef struct
 {
   uint64_t      peerAddr;             /*!< Peer address. */
   uint64_t      peerIdAddr;           /*!< Peer ID address. */
   uint8_t       pduType;              /*!< PDU type. */
   uint8_t       pduLen;               /*!< PDU length. */
   bool_t        peerAddrRand;         /*!< TRUE if peer address is random. */
   bool_t        peerIdAddrRand;       /*!< TRUE if peer ID address is random. */
   bool_t        peerMatch;            /*!< TRUE if peer address was resolved or matched. */
   bool_t        localMatch;           /*!< TRUE if local address was resolved or matched. */
 } bbBlePduFiltResults_t;
 
 /**************************************************************************************************
   Function Declarations
 **************************************************************************************************/
 
 /*************************************************************************************************/
 /*!
  *  \brief      Check if PDU is allowed, i.e., should not be ignored.
  *
  *  \param      pBuf              PDU buffer.
  *  \param      pFiltParams       Filter parameters.
  *  \param      forceRes          TRUE if address resolution should be forced.
  *  \param      pFiltResults      Storage for filter results.
  *
  *  \return     TRUE if PDU is allowed, FALSE if PDU should be ignored.
  */
 /*************************************************************************************************/
 bool_t BbBlePduFiltCheck(const uint8_t *pBuf, const bbBlePduFiltParams_t *pFiltParams,
                          bool_t forceRes, bbBlePduFiltResults_t *pFiltResults);
 
 /*************************************************************************************************/
 /*!
  *  \brief      Check if PDU is allowed, i.e., should not be ignored.
  *
  *  \param      pExtFiltParams    Extended filter parameters.
  *  \param      pFiltParams       Filter parameters.
  *  \param      forceRes          TRUE if address resolution should be forced.
  *  \param      pFiltResults      Storage for filter results.
  *
  *  \return     TRUE if PDU is allowed, FALSE if PDU should be ignored.
  */
 /*************************************************************************************************/
 bool_t BbBleExtPduFiltCheck(const bbBlePduExtFiltParams_t *pExtFiltParams,
                             const bbBlePduFiltParams_t *pFiltParams,
                             bool_t forceRes, bbBlePduFiltResults_t *pFiltResults);
 
 /*************************************************************************************************/
 /*!
  *  \brief      Get the peer ID address.
  *
  *  \param      pFiltResults      Filter results.
  *  \param      pPeerIdAddr       Storage for peer ID address.
  *  \param      pPeerIdAddrType   Storage for peer ID address type;
  */
 /*************************************************************************************************/
 static inline void BbBlePduFiltResultsGetPeerIdAddr(const bbBlePduFiltResults_t *pFiltResults, uint64_t *pPeerIdAddr, uint8_t *pPeerIdAddrType)
 {
   const unsigned int addrIdBit = 1 << 1;
 
   *pPeerIdAddrType = pFiltResults->peerIdAddrRand;
   if ((pFiltResults->peerIdAddrRand != pFiltResults->peerAddrRand) ||
       (pFiltResults->peerIdAddr     != pFiltResults->peerAddr))
   {
     *pPeerIdAddrType |= addrIdBit;
   }
   *pPeerIdAddr = pFiltResults->peerIdAddr;
 }
 
 /*************************************************************************************************/
 /*!
  *  \brief      Get the peer RPA.
  *
  *  \param      pFiltResults      Filter results.
  *  \param      pPeerRpa          Storage for peer RPA or 0.
  */
 /*************************************************************************************************/
 static inline void BbBlePduFiltResultsGetPeerRpa(const bbBlePduFiltResults_t *pFiltResults, uint64_t *pPeerRpa)
 {
   *pPeerRpa = 0;
   if ((pFiltResults->peerIdAddrRand != pFiltResults->peerAddrRand) ||
       (pFiltResults->peerIdAddr     != pFiltResults->peerAddr))
   {
     *pPeerRpa = pFiltResults->peerAddr;
   }
 }
 
 /*! \} */    /* BB_API_BLE_PDU_FILT */
 
 #ifdef __cplusplus
 };
 #endif
 
 #endif /* BB_BLE_API_PDUFILT_H */
Important Information for this Arm website
