RF Core

Data Structures
struct	rfTrim_t

Functions
static void	RFCClockEnable (void)
	Enable the RF core clocks. More...
static void	RFCClockDisable (void)
	Disable the RF core clocks. More...
static void	RFCCpeIntClear (uint32_t ui32Mask)
	Clear HW interrupt flags. More...
static void	RFCHwIntClear (uint32_t ui32Mask)
	Clear CPE interrupt flags. More...
static void	RFCCpe0IntSelect (uint32_t ui32Mask)
	Select interrupt sources to CPE0 (assign to INT_RFC_CPE_0 interrupt vector). More...
static void	RFCCpe1IntSelect (uint32_t ui32Mask)
	Select interrupt sources to CPE1 (assign to INT_RFC_CPE_1 interrupt vector). More...
static void	RFCCpeIntEnable (uint32_t ui32Mask)
	Enable CPEx interrupt sources. More...
static void	RFCCpe0IntSelectClearEnable (uint32_t ui32Mask)
	Select, clear, and enable interrupt sources to CPE0. More...
static void	RFCCpe1IntSelectClearEnable (uint32_t ui32Mask)
	Select, clear, and enable interrupt sources to CPE1. More...
static void	RFCHwIntEnable (uint32_t ui32Mask)
	Enable HW interrupt sources. More...
static void	RFCCpeIntDisable (uint32_t ui32Mask)
	Disable CPE interrupt sources. More...
static void	RFCHwIntDisable (uint32_t ui32Mask)
	Disable HW interrupt sources. More...
uint32_t	RFCCpeIntGetAndClear (uint32_t ui32Mask)
	Get and clear CPE interrupt flags. More...
static void	RFCAckIntClear (void)
	Clear ACK interrupt flag. More...
uint32_t	RFCDoorbellSendTo (uint32_t pOp)
	Send a radio operation to the doorbell and wait for an acknowledgment. More...
void	RFCSynthPowerDown (void)
	This function implements a fast way to turn off the synthesizer. More...
void	RFCCpePatchReset (void)
	Reset previously patched CPE RAM to a state where it can be patched again. More...
uint8_t	RFCOverrideSearch (const uint32_t *pOverride, const uint32_t pattern, const uint32_t mask, const uint8_t searchDepth)
uint8_t	RFCOverrideUpdate (rfc_radioOp_t *pOpSetup, uint32_t *pParams)
	Function to update override list. More...
uint32_t	RFCHwIntGetAndClear (uint32_t ui32Mask)
	Get and clear HW interrupt flags. More...
static bool	RFCGetPaType (void)
	Get the type of currently selected PA. More...
static uint32_t	RFCGetPaGain (void)
	Get the gain of currently selected PA. More...
uint32_t	RFCAnaDivTxOverride (uint8_t loDivider, uint8_t frontEndMode)
	Function to calculate the proper override run-time for the High Gain PA. More...

Detailed Description

Function Documentation

static void RFCAckIntClear ( void  )

inlinestatic

Clear ACK interrupt flag.

Referenced by RFCDoorbellSendTo().

{
    // Clear any pending interrupts.
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFACKIFG) = 0x0;
}

uint32_t RFCAnaDivTxOverride	(	uint8_t	loDivider,
		uint8_t	frontEndMode
	)

Function to calculate the proper override run-time for the High Gain PA.

{
   uint16_t fsOnly;
   uint16_t txSetting;

   switch (loDivider)
   {
        case 0: fsOnly = 0x0502;
                break;
        case 2:
                fsOnly = 0x0102;
                break;
        case 4:
        case 6:
        case 12:
                fsOnly = 0xF101;
                break;
        case 5:
        case 10:
        case 15:
        case 30:
                fsOnly = 0x1101;
                break;
        default:
                // Error, should not occur!
                fsOnly = 0;
                break;
   }

   if (frontEndMode == 255)
   {
        // Special value meaning 20 dBm PA
        txSetting = (fsOnly | 0x00C0) & ~0x0400;
   }
   else if (frontEndMode == 0)
   {
        // Differential
        txSetting = fsOnly | 0x0030;
   }
   else if (frontEndMode & 1)
   {
        // Single ended on RFP
        txSetting = fsOnly | 0x0010;
   }
   else
   {
        // Single ended on RFN
        txSetting = fsOnly | 0x0020;
   }

   return ((((uint32_t) txSetting) << 16) | RFC_FE_OVERRIDE_ADDRESS);
}

static void RFCClockDisable ( void  )

inlinestatic

Disable the RF core clocks.

As soon as the RF core is started it will handle clock control autonomously. No check should be performed to check the clocks. Instead the radio can be ping'ed through the command interface.

When disabling clocks it is the programmers responsibility that the RF core clocks are safely gated. I.e. the RF core should be safely 'parked'.

Returns

None

{
    // Disable all clocks
    HWREG(RFC_PWR_NONBUF_BASE + RFC_PWR_O_PWMCLKEN) = 0x0;
}

static void RFCClockEnable ( void  )

inlinestatic

Enable the RF core clocks.

As soon as the RF core is started it will handle clock control autonomously. No check should be performed to check the clocks. Instead the radio can be ping'ed through the command interface.

Returns

None

{
    // Enable basic clocks to get the CPE run
    HWREG(RFC_PWR_NONBUF_BASE + RFC_PWR_O_PWMCLKEN) = RFC_PWR_PWMCLKEN_CPERAM
                                                    | RFC_PWR_PWMCLKEN_CPE
                                                    | RFC_PWR_PWMCLKEN_RFC;
}

static void RFCCpe0IntSelect ( uint32_t  ui32Mask )

inlinestatic

Select interrupt sources to CPE0 (assign to INT_RFC_CPE_0 interrupt vector).

Referenced by RFCCpe0IntSelectClearEnable().

{
    // Multiplex RF Core interrupts to CPE0 IRQ.
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFCPEISL) &= ~ui32Mask;
}

static void RFCCpe0IntSelectClearEnable ( uint32_t  ui32Mask )

inlinestatic

Select, clear, and enable interrupt sources to CPE0.

{
    // Multiplex RF Core interrupts to CPE0 IRQ.
    RFCCpe0IntSelect(ui32Mask);

    // Clear the masked interrupts.
    RFCCpeIntClear(ui32Mask);

    // Enable the masked interrupts.
    RFCCpeIntEnable(ui32Mask);
}

Here is the call graph for this function:

static void RFCCpe1IntSelect ( uint32_t  ui32Mask )

inlinestatic

Select interrupt sources to CPE1 (assign to INT_RFC_CPE_1 interrupt vector).

Referenced by RFCCpe1IntSelectClearEnable().

{
    // Multiplex RF Core interrupts to CPE1 IRQ.
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFCPEISL) |= ui32Mask;
}

static void RFCCpe1IntSelectClearEnable ( uint32_t  ui32Mask )

inlinestatic

Select, clear, and enable interrupt sources to CPE1.

{
    // Multiplex RF Core interrupts to CPE1 IRQ.
    RFCCpe1IntSelect(ui32Mask);

    // Clear the masked interrupts.
    RFCCpeIntClear(ui32Mask);

    // Enable the masked interrupts.
    RFCCpeIntEnable(ui32Mask);
}

Here is the call graph for this function:

static void RFCCpeIntClear ( uint32_t  ui32Mask )

inlinestatic

Clear HW interrupt flags.

Referenced by RFCCpe0IntSelectClearEnable(), RFCCpe1IntSelectClearEnable(), and RFCCpeIntGetAndClear().

{
    // Clear the masked pending interrupts.
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFCPEIFG) = ~ui32Mask;
}

static void RFCCpeIntDisable ( uint32_t  ui32Mask )

inlinestatic

Disable CPE interrupt sources.

{
    // Disable the masked interrupts
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFCPEIEN) &= ~ui32Mask;
}

static void RFCCpeIntEnable ( uint32_t  ui32Mask )

inlinestatic

Enable CPEx interrupt sources.

Referenced by RFCCpe0IntSelectClearEnable(), and RFCCpe1IntSelectClearEnable().

{
    // Enable CPE interrupts from RF Core.
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFCPEIEN) |= ui32Mask;
}

uint32_t RFCCpeIntGetAndClear

(

uint32_t

ui32Mask

)

Get and clear CPE interrupt flags.

{
    // Read the CPE interrupt flags which match the provided bitmask
    uint32_t ui32Ifg = HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFCPEIFG) & ui32Mask;

    // Clear the interrupt flags
    RFCCpeIntClear(ui32Ifg);

    // Return with the interrupt flags
    return (ui32Ifg);
}

Here is the call graph for this function:

void RFCCpePatchReset

(

void

)

Reset previously patched CPE RAM to a state where it can be patched again.

{
    // Function is not complete
}

uint32_t RFCDoorbellSendTo

(

uint32_t

pOp

)

Send a radio operation to the doorbell and wait for an acknowledgment.

{
    // Wait until the doorbell becomes available
    while(HWREG(RFC_DBELL_BASE + RFC_DBELL_O_CMDR) != 0);
    RFCAckIntClear();

    // Submit the command to the CM0 through the doorbell
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_CMDR) = pOp;

    // Wait until the CM0 starts to parse the command
    while(!HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFACKIFG));
    RFCAckIntClear();

    // Return with the content of status register
    return(HWREG(RFC_DBELL_BASE + RFC_DBELL_O_CMDSTA));
}

Here is the call graph for this function:

static uint32_t RFCGetPaGain ( void  )

inlinestatic

Get the gain of currently selected PA.

{
    return (HWREG(RFC_PA_GAIN_ADDRESS) & RFC_PA_GAIN_MASK);
}

static bool RFCGetPaType ( void  )

inlinestatic

Get the type of currently selected PA.

{
    return (bool)(HWREGB(RFC_PA_TYPE_ADDRESS) & RFC_PA_TYPE_MASK);
}

static void RFCHwIntClear ( uint32_t  ui32Mask )

inlinestatic

Clear CPE interrupt flags.

Referenced by RFCHwIntGetAndClear().

{
    // Clear the masked pending interrupts.
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFHWIFG) = ~ui32Mask;
}

static void RFCHwIntDisable ( uint32_t  ui32Mask )

inlinestatic

Disable HW interrupt sources.

{
    // Disable the masked interrupts
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFHWIEN) &= ~ui32Mask;
}

static void RFCHwIntEnable ( uint32_t  ui32Mask )

inlinestatic

Enable HW interrupt sources.

{
    // Enable the masked interrupts
    HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFHWIEN) |= ui32Mask;
}

uint32_t RFCHwIntGetAndClear

(

uint32_t

ui32Mask

)

Get and clear HW interrupt flags.

{
    // Read the CPE interrupt flags which match the provided bitmask
    uint32_t ui32Ifg = HWREG(RFC_DBELL_BASE + RFC_DBELL_O_RFHWIFG) & ui32Mask;

    // Clear the interupt flags
    RFCHwIntClear(ui32Ifg);

    // Return with the interrupt flags
    return (ui32Ifg);
}

Here is the call graph for this function:

uint8_t RFCOverrideSearch	(	const uint32_t *	pOverride,
		const uint32_t	pattern,
		const uint32_t	mask,
		const uint8_t	searchDepth
	)

{
    // Search from start of the override list, to look for first override entry that matches search pattern
    uint8_t override_index;
    for(override_index = 0; (override_index < searchDepth) && (pOverride[override_index] != END_OVERRIDE); override_index++)
    {
        // Compare the value to the given pattern
        if((pOverride[override_index] & mask) == pattern)
        {
            // Return with the index of override in case of match
            return override_index;
        }
    }

    // Return with an invalid index
    return 0xFF;
}

uint8_t RFCOverrideUpdate	(	rfc_radioOp_t *	pOpSetup,
		uint32_t *	pParams
	)

Function to update override list.

{
    // Function is left blank for compatibility reasons.
    return 0;
}

void RFCSynthPowerDown

(

void

)

This function implements a fast way to turn off the synthesizer.

{
    // Definition of reserved words
    const uint32_t RFC_RESERVED0 = 0x40046054;
    const uint32_t RFC_RESERVED1 = 0x40046060;
    const uint32_t RFC_RESERVED2 = 0x40046058;
    const uint32_t RFC_RESERVED3 = 0x40044100;

    // Disable CPE clock, enable FSCA clock.
    HWREG(RFC_PWR_NONBUF_BASE + RFC_PWR_O_PWMCLKEN) = (HWREG(RFC_PWR_NONBUF_BASE + RFC_PWR_O_PWMCLKEN)
                                                    & ~RFC_PWR_PWMCLKEN_CPE_M) | RFC_PWR_PWMCLKEN_FSCA_M | RFC_PWR_PWMCLKEN_RFE_M;

    HWREG(RFC_RESERVED0) = 3;
    HWREG(RFC_RESERVED1) = 0x1030;
    HWREG(RFC_RESERVED2) = 1;
    HWREG(RFC_RESERVED1) = 0x50;
    HWREG(RFC_RESERVED2) = 1;
    HWREG(RFC_RESERVED1) = 0x650;
    HWREG(RFC_RESERVED2) = 1;
    HWREG(RFC_RESERVED1) = 0x10C0;
    HWREG(RFC_RESERVED2) = 1;
    HWREG(RFC_RESERVED3) = 1;
}

Macro Definition Documentation

#define RFC_FE_MODE_ESCAPE_VALUE   0xFF

#define RFC_FE_OVERRIDE_ADDRESS   0x0703

Referenced by RFCAnaDivTxOverride().

#define RFC_FE_OVERRIDE_MASK   0x0000FFFF

#define RFC_MAX_SEARCH_DEPTH   5

#define RFC_PA_GAIN_ADDRESS   0x2100034C

Referenced by RFCGetPaGain().

#define RFC_PA_GAIN_MASK   0x003FFFFF

Referenced by RFCGetPaGain().

#define RFC_PA_TYPE_ADDRESS   0x21000345

Referenced by RFCGetPaType().

#define RFC_PA_TYPE_MASK   0x04

Referenced by RFCGetPaType().