RF.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_rf__include
#define ti_drivers_rf__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <ti/sysbios/BIOS.h>
#include <ti/sysbios/knl/Clock.h>
#include <ti/sysbios/knl/Semaphore.h>
#include <driverlib/rf_common_cmd.h>
#include <driverlib/rf_prop_cmd.h>


#define RF_MODE_PROPRIETARY     0x00


typedef rfc_radioOp_t RF_Op;


typedef struct {
    uint8_t rfMode;             
    void (*cpePatchFxn)(void);  
    void (*mcePatchFxn)(void);  
    void (*rfePatchFxn)(void);  
} RF_Mode;


typedef enum {
    RF_PriorityHighest = 0, 
    RF_PriorityHigh    = 1, 
    RF_PriorityNormal  = 2, 
    RF_PriorityLow     = 3  
} RF_Priority;


typedef enum {
    RF_EventCmdDone         = (1<<1),  
    RF_EventCmdCancelled    = (1<<2),  
    RF_EventCmdStopped      = (1<<3),  
    RF_EventCmdAborted      = (1<<29), 
    RF_EventCmdError        = (1<<30), 
    RF_EventRxOk            = (1<<16), 
    RF_EventRxNok           = (1<<17), 
    RF_EventRxEntryDone     = (1<<23), 
    RF_EventDataWritten     = (1<<24), 
    RF_EventNDataWritten    = (1<<25), 
    RF_EventRxBufFull       = (1<<22), 
    RF_EventRxAborted       = (1<<26), 
    RF_EventTxEntryDone     = (1<<10), 
} RF_Event;


typedef uint64_t RF_EventMask;


typedef union {
    rfc_command_t               naked;      // Can be used simply to get RF operation ID
    rfc_CMD_RADIO_SETUP_t       common;
    rfc_CMD_PROP_RADIO_SETUP_t  prop;
} RF_RadioSetup;


typedef int16_t RF_CmdHandle;


typedef struct {
    uint32_t nInactivityTimeout;   
} RF_Params;


typedef struct {
    struct {
        uint32_t            nInactivityTimeout;   
        RF_Mode*            pRfMode;              
        RF_RadioSetup*      pOpSetup;             
    } config;
    struct {
        struct {
            rfc_CMD_FS_t        cmdFs;            
            union {
                struct {
                    uint8_t     foo;
                } prop;                           
                struct {
                    uint8_t     foo;
                } ble;                            
                struct {
                    uint8_t     foo;
                } ieee;                           
            };
        } mode_state;                               
        Semaphore_Struct        semSync;            
        RF_Event volatile       eventSync;          
        void*                   pCbSync;            
        RF_Event                unpendCause;        
        Clock_Struct            clkInactivity;      
        RF_CmdHandle volatile   chLastPosted;       
        bool                    bYielded;           
    } state;
} RF_Object;


typedef RF_Object* RF_Handle;


typedef void (*RF_Callback)(RF_Handle h, RF_CmdHandle ch, RF_Event e);


extern RF_Handle RF_open(RF_Object *pObj, RF_Mode *pRfMode, RF_RadioSetup *pOpSetup, RF_Params *params);


extern void RF_close(RF_Handle h);


extern uint32_t RF_getCurrentTime(void);


extern RF_CmdHandle RF_postCmd(RF_Handle h, RF_Op* pOp, RF_Priority ePri, RF_Callback pCb, RF_EventMask bmEvent);


extern RF_Event RF_waitCmd(RF_Handle h, RF_CmdHandle ch, RF_EventMask bmEvent);


extern RF_Event RF_runCmd(RF_Handle h, RF_Op* pOp, RF_Priority ePri, RF_Callback pCb, RF_EventMask bmEvent);


extern void RF_abortCmd(RF_Handle h, RF_CmdHandle ch, bool bGraceful);


extern void RF_yield(RF_Handle h);


extern void RF_Params_init(RF_Params *params);


// Do not interfere with the app if they include the family Hwi module
#undef ti_sysbios_family_arm_m3_Hwi__nolocalnames

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_rf__include */