BSP430  20141115
Board Support Package for MSP430 microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Macros
rfem.h File Reference

RF Evaluation Module connector support. More...

#include <bsp430/rf.h>

Go to the source code of this file.

Macros

#define configBSP430_RFEM_CCEM   0
 
#define configBSP430_RFEM   0
 
#define BSP430_RFEM_CCEM   include <bsp430/platform.h>
 
#define BSP430_RFEM   include <bsp430/platform.h>
 
#define BSP430_RFEM_SERIAL_PERIPH_CPPID   include <bsp430/platform.h>
 
#define BSP430_RFEM_SERIAL_PERIPH_HANDLE   include <bsp430/platform.h>
 
#define BSP430_RFEM_RF1P20_PORT_PERIPH_CPPID   include <bsp430/platform.h>
 
#define BSP430_RFEM_RF1P20_PORT_PERIPH_HANDLE   include <bsp430/platform.h>
 
#define BSP430_RFEM_RF1P20_PORT_BIT   include <bsp430/platform.h>
 
#define BSP430_RFEM_RF1P20_TIMER_PERIPH_CPPID   include <bsp430/platform.h>
 
#define BSP430_RFEM_RF1P20_TIMER_PERIPH_HANDLE   include <bsp430/platform.h>
 
#define BSP430_RFEM_RF1P20_TIMER_CCIDX   include <bsp430/platform.h>
 
#define BSP430_RFEM_RF1P20_TIMER_CCIS   include <bsp430/platform.h>
 

Detailed Description

RF Evaluation Module connector support.

Many MSP430 evaluation boards support an RF interface, often in the form of the RF1/RF2 Evaluation Module connector and/or its companion RF3 header (also known as the eZ-RF header). This header describes standard names associating the platform-specific GPIO ports and secondary functions with each pin. These in turn can be used to associate signals from specific RF EMK boards (e.g. the CC1101EMK or CC2520EMK) with the MCU pins using the RFEM pins as a bridge.

Although the standard RFEM connector comprises two 20-pin header blocks, not all EM boards provide connections for all pins.

For simplicity only pin 20 on the RF1 header is fully described here. The remaining 19 pins on RF1, 20 pins on RF2, and 18 pins on RF3 are used analogously.

In standard SPI usage, SCLK is in RF1P16, SI is RF1P18, SO is RF1P20, and CSn is RF1P14. The platform-specific serial device associated with these RFEM pins is BSP430_RFEM_SERIAL_PERIPH_HANDLE.

Note
It is never necessary to include this file directly. It serves entirely as a point of documentation for macros that are defined through <bsp430/platform.h>
Homepage
http://github.com/pabigot/bsp430

Macro Definition Documentation

#define BSP430_RFEM   include <bsp430/platform.h>

Indicate that the RFEM interface is available on the platform, either natively or thorough a booster pack. This is normally set by the platform-specific header included by <bsp430/platform.h> when configBSP430_RFEM (or a RFEM-supporting booster-pack configuration flag) is true. If it is unset or false, the platform does not support the RFEM interface and RFEM identifiers in this module should not be referenced.

This flag is defined only if configBSP430_RFEM is true.

Dependency:
configBSP430_RFEM, configBSP430_RFEM_CCEM
Platform-Based Value:
Undefined here; include <bsp430/platform.h> to obtain the correct value of this macro.
#define BSP430_RFEM_CCEM   include <bsp430/platform.h>

Indicate that the RFEM interface is available on the platform through use of an attached EM Adapter BoosterPack. This is normally set by the platform-specific header included by <bsp430/platform.h> when configBSP430_RFEM_CCEM is true. If it is unset or false, the platform does not support the RFEM interface through the EM Adapter Booster Pack.

This flag is defined only if configBSP430_RFEM_CCEM is true.

Dependency:
configBSP430_RFEM_CCEM
Platform-Based Value:
Undefined here; include <bsp430/platform.h> to obtain the correct value of this macro.
#define BSP430_RFEM_RF1P20_PORT_BIT   include <bsp430/platform.h>

The port bit (mask) associated with the GPIO port peripheral pin connected to RF1 header pin 20 on a target board.

Defined analogously by each platform for all connected pins on RF1, RF2, and RF3. If the macro for a specific header pin is not defined by a platform, that header pin is not connected to the MCU.

See also
BSP430_RFEM_RF1P20_PORT_PERIPH_HANDLE.
#define BSP430_RFEM_RF1P20_PORT_PERIPH_CPPID   include <bsp430/platform.h>

The CPPID associated with the port peripheral controlling pin 20 on the RF1 header on a target board.

Defined analogously by each platform for all connected pins on RF1, RF2, and RF3. If the macro for a specific header pin is not defined by a platform, that header pin is not connected to the MCU.

#define BSP430_RFEM_RF1P20_PORT_PERIPH_HANDLE   include <bsp430/platform.h>

A specific port handle, such as BSP430_PERIPH_PORT1, associated with the port peripheral controlling pin 20 on the RF1 header on a target board.

Defined analogously by each platform for all connected pins on RF1, RF2, and RF3. If the macro for a specific header pin is not defined by a platform, that header pin is not connected to the MCU.

See also
BSP430_RFEM_RF1P20_PORT_BIT.
#define BSP430_RFEM_RF1P20_TIMER_CCIDX   include <bsp430/platform.h>

The capture/compare index on BSP430_RFEM_RF1P20_TIMER_PERIPH_HANDLE that is connected to pin 20 on the RF1 header of a target board.

Defined analogously by each platform for all connected pins on RF1, RF2, and RF3. If the macro for a specific header pin is not defined by a platform, that header pin is not connected to a timer peripheral on the MCU.

See also
BSP430_RFEM_RF1P20_TIMER_PERIPH_HANDLE
#define BSP430_RFEM_RF1P20_TIMER_CCIS   include <bsp430/platform.h>

The capture/compare input selector necessary to capture on BSP430_RFEM_RF1P20_TIMER_PERIPH_HANDLE any signal changes associated with pin 20 on the RF1 header of a target board.

Defined analogously by each platform for all connected pins on RF1, RF2, and RF3. If the macro for a specific header pin is not defined by a platform, that header pin is not connected to a timer peripheral on the MCU.

See also
BSP430_RFEM_RF1P20_TIMER_PERIPH_HANDLE
BSP430_RFEM_RF1P20_TIMER_CCIDX
#define BSP430_RFEM_RF1P20_TIMER_PERIPH_CPPID   include <bsp430/platform.h>

The CPPID associated with a timer peripheral available as the primary peripheral function on pin 20 on the RF1 header on a target board.

Defined analogously by each platform for all connected pins on RF1, RF2, and RF3. If the macro for a specific header pin is not defined by a platform, that header pin is not connected to a timer peripheral on the MCU.

See also
BSP430_RFEM_RF1P20_TIMER_PERIPH_HANDLE
#define BSP430_RFEM_RF1P20_TIMER_PERIPH_HANDLE   include <bsp430/platform.h>

A specific timer handle, such as BSP430_PERIPH_TA0, associated with a timer peripheral available as the primary peripheral function on pin 20 on the RF1 header on a target board.

("primary peripheral function" means that the corresponding BSP430_RFEM_RF1P20_PORT_BIT is set on the sel register of the BSP430_RFEM_RF1P20_PORT_PERIPH_HANDLE port peripheral associated with the RF header pin, while that bit is cleared on any secondary selection registers. See BSP430_PORT_SUPPORTS_SEL2.)

Defined analogously by each platform for all connected pins on RF1, RF2, and RF3. If the macro for a specific header pin is not defined by a platform, that header pin is not connected to a timer peripheral on the MCU.

#define BSP430_RFEM_SERIAL_PERIPH_CPPID   include <bsp430/platform.h>

The CPPID associated with the serial device serving as the primary SPI interface on the RF headers.

#define BSP430_RFEM_SERIAL_PERIPH_HANDLE   include <bsp430/platform.h>

The serial peripheral serving as the primary SPI interface on the RF headers.

#define configBSP430_RFEM   0

Define to a true value to indicate intent to use the platform's native RFEM interface. If supported by the platform, this will provide definitions for the relevant ports and pins, and request the relevant peripherals.

Note
This flag is to be used when the platform natively supports an RFEM connector. When the RFEM connector is provided through a booster pack (e.g. configBSP430_RFEM_CCEM), the request for the feature should be made by setting that option.
C Preprocessor Only:
This macro may have a value that restricts its use to C preprocessor conditional directives.
Affects:
BSP430_RFEM
Defaulted:
The value here is superseded by previously encountered definitions.
#define configBSP430_RFEM_CCEM   0

Define to a true value to indicate intent to use the RFEM interface as provided through an attached EM Adapter BoosterPack. If supported by the platform, this will provide definitions for the relevant ports and pins, and request the relevant peripherals.

C Preprocessor Only:
This macro may have a value that restricts its use to C preprocessor conditional directives.
Affects:
BSP430_RFEM_CCEM, BSP430_RFEM
Defaulted:
The value here is superseded by previously encountered definitions.