module ti.mcu.msp430.runtime.utils.Button

index URL

Simple momentary button switch manager

C synopsis
Individual elements
XDCscript usage
Individual elements

C synopsis target-domain sourced in ti/mcu/msp430/runtime/utils/Button.xdc

#include <ti/mcu/msp430/runtime/utils/Button.h>

Functions
Void	Button_disable// Disable the specified buttons(Bits8 mask);
Void	Button_enable// Enable the specified buttons(Bits8 mask);
Bits8	Button_read// Atomically read and clear the specified buttons(Bits8 mask);
Functions common to all target modules
	Button_Module_getMask// Returns the diagnostics mask for this module, Button_Module_hasMask// Test whether this module has a diagnostics mask, Button_Module_heap// The heap from which this module allocates memory, Button_Module_id// Get this module's unique id, Button_Module_setMask// Set the diagnostics mask for this module, Button_Module_startupDone// Test if this module has completed startup
Constants
extern const Ptr	Button_PORT// Address of 8-bit output port to use;
extern const Ptr	Button_PORT_IE// Address of Interrupt Enable register;
extern const Ptr	Button_PORT_IFG// Address of Interrupt Flag register;
extern const Ptr	Button_PORT_OUT// Address of output configuration register;
extern const Ptr	Button_PORT_REN// Address of pullup/down resister enable configuration register;
extern const Bits8	Button_SWITCH1// Port mask for switch #1;
extern const Bits8	Button_SWITCH2// Port mask for switch #2;

config Button_PORT // module-wide

index URL

Address of 8-bit output port to use

C synopsis target-domain

extern const Ptr Button_PORT;

config Button_PORT_IE // module-wide

index URL

Address of Interrupt Enable register

C synopsis target-domain

extern const Ptr Button_PORT_IE;

config Button_PORT_IFG // module-wide

index URL

Address of Interrupt Flag register

C synopsis target-domain

extern const Ptr Button_PORT_IFG;

config Button_PORT_OUT // module-wide

index URL

Address of output configuration register

C synopsis target-domain

extern const Ptr Button_PORT_OUT;

config Button_PORT_REN // module-wide

index URL

Address of pullup/down resister enable configuration register

C synopsis target-domain

extern const Ptr Button_PORT_REN;

config Button_SWITCH1 // module-wide

index URL

Port mask for switch #1

C synopsis target-domain

extern const Bits8 Button_SWITCH1;

config Button_SWITCH2 // module-wide

index URL

Port mask for switch #2

C synopsis target-domain

extern const Bits8 Button_SWITCH2;

Button_disable() // module-wide

index URL

Disable the specified buttons

C synopsis target-domain

Void Button_disable(Bits8 mask);

Button_enable() // module-wide

index URL

Enable the specified buttons

C synopsis target-domain

Void Button_enable(Bits8 mask);

Button_read() // module-wide

index URL

Atomically read and clear the specified buttons

C synopsis target-domain

Bits8 Button_read(Bits8 mask);

DETAILS

This function returns the state of the buttons and clears their state. Only the state of the buttons specified by mask are affected.

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId Button_Module_id();

// Get this module's unique id

Bool Button_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle Button_Module_heap();

// The heap from which this module allocates memory

Bool Button_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 Button_Module_getMask();

// Returns the diagnostics mask for this module

Void Button_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

XDCscript usage meta-domain sourced in ti/mcu/msp430/runtime/utils/Button.xdc

var Button = xdc.useModule('ti.mcu.msp430.runtime.utils.Button');

module-wide config parameters

const Button.PORT0// = Ptr 0x11;

const Button.PORT0_IE// = Ptr 0x15;

const Button.PORT0_IFG// = Ptr 0x13;

const Button.PORT0_OUT// = Ptr 0x11;

const Button.PORT0_REN// = Ptr 0x11;

const Button.PORT1// = Ptr 0x21;

const Button.PORT1_IE// = Ptr 0x25;

const Button.PORT1_IFG// = Ptr 0x23;

const Button.PORT1_OUT// = Ptr 0x21;

const Button.PORT1_REN// = Ptr 0x27;

const Button.PORT2// = Ptr 0x29;

const Button.PORT2_IE// = Ptr 0x2D;

const Button.PORT2_IFG// = Ptr 0x2B;

const Button.PORT2_OUT// = Ptr 0x29;

const Button.PORT2_REN// = Ptr 0x2F;

const Button.PORTA_IE_H// = Ptr 0x21B;

const Button.PORTA_IE_L// = Ptr 0x21A;

const Button.PORTA_IFG_H// = Ptr 0x21D;

const Button.PORTA_IFG_L// = Ptr 0x21C;

const Button.PORTA_OUT_H// = Ptr 0x203;

const Button.PORTA_OUT_L// = Ptr 0x202;

const Button.PORTA_REN_H// = Ptr 0x207;

const Button.PORTA_REN_L// = Ptr 0x206;

Button.PORT// Address of 8-bit output port to use = Ptr Button.PORT1;

Button.PORT_IE// Address of Interrupt Enable register = Ptr Button.PORT1_IE;

Button.PORT_IFG// Address of Interrupt Flag register = Ptr Button.PORT1_IFG;

Button.PORT_OUT// Address of output configuration register = Ptr Button.PORT1_OUT;

Button.PORT_REN// Address of pullup/down resister enable configuration register = Ptr Button.PORT1_REN;

Button.SWITCH1// Port mask for switch #1 = Bits8 0x1;

Button.SWITCH2// Port mask for switch #2 = Bits8 0x2;

Button.common$// Common module configuration parameters = Types.Common$ undefined;

metaonly config Button.PORT0 // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT0 = Ptr 0x11;

metaonly config Button.PORT0_IE // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT0_IE = Ptr 0x15;

metaonly config Button.PORT0_IFG // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT0_IFG = Ptr 0x13;

metaonly config Button.PORT0_OUT // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT0_OUT = Ptr 0x11;

metaonly config Button.PORT0_REN // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT0_REN = Ptr 0x11;

metaonly config Button.PORT1 // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT1 = Ptr 0x21;

metaonly config Button.PORT1_IE // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT1_IE = Ptr 0x25;

metaonly config Button.PORT1_IFG // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT1_IFG = Ptr 0x23;

metaonly config Button.PORT1_OUT // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT1_OUT = Ptr 0x21;

metaonly config Button.PORT1_REN // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT1_REN = Ptr 0x27;

metaonly config Button.PORT2 // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT2 = Ptr 0x29;

metaonly config Button.PORT2_IE // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT2_IE = Ptr 0x2D;

metaonly config Button.PORT2_IFG // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT2_IFG = Ptr 0x2B;

metaonly config Button.PORT2_OUT // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT2_OUT = Ptr 0x29;

metaonly config Button.PORT2_REN // module-wide

index URL

XDCscript usage meta-domain

const Button.PORT2_REN = Ptr 0x2F;

metaonly config Button.PORTA_IE_H // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_IE_H = Ptr 0x21B;

metaonly config Button.PORTA_IE_L // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_IE_L = Ptr 0x21A;

metaonly config Button.PORTA_IFG_H // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_IFG_H = Ptr 0x21D;

metaonly config Button.PORTA_IFG_L // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_IFG_L = Ptr 0x21C;

metaonly config Button.PORTA_OUT_H // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_OUT_H = Ptr 0x203;

metaonly config Button.PORTA_OUT_L // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_OUT_L = Ptr 0x202;

metaonly config Button.PORTA_REN_H // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_REN_H = Ptr 0x207;

metaonly config Button.PORTA_REN_L // module-wide

index URL

XDCscript usage meta-domain

const Button.PORTA_REN_L = Ptr 0x206;

config Button.PORT // module-wide

index URL

Address of 8-bit output port to use

XDCscript usage meta-domain

Button.PORT = Ptr Button.PORT1;

C SYNOPSIS

Button_PORT

config Button.PORT_IE // module-wide

index URL

Address of Interrupt Enable register

XDCscript usage meta-domain

Button.PORT_IE = Ptr Button.PORT1_IE;

C SYNOPSIS

Button_PORT_IE

config Button.PORT_IFG // module-wide

index URL

Address of Interrupt Flag register

XDCscript usage meta-domain

Button.PORT_IFG = Ptr Button.PORT1_IFG;

C SYNOPSIS

Button_PORT_IFG

config Button.PORT_OUT // module-wide

index URL

Address of output configuration register

XDCscript usage meta-domain

Button.PORT_OUT = Ptr Button.PORT1_OUT;

C SYNOPSIS

Button_PORT_OUT

config Button.PORT_REN // module-wide

index URL

Address of pullup/down resister enable configuration register

XDCscript usage meta-domain

Button.PORT_REN = Ptr Button.PORT1_REN;

C SYNOPSIS

Button_PORT_REN

config Button.SWITCH1 // module-wide

index URL

Port mask for switch #1

XDCscript usage meta-domain

Button.SWITCH1 = Bits8 0x1;

C SYNOPSIS

Button_SWITCH1

config Button.SWITCH2 // module-wide

index URL

Port mask for switch #2

XDCscript usage meta-domain

Button.SWITCH2 = Bits8 0x2;

C SYNOPSIS

Button_SWITCH2

metaonly config Button.common$ // module-wide

index URL

Common module configuration parameters

XDCscript usage meta-domain

Button.common$ = Types.Common$ undefined;

DETAILS

All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.

generated on Thu, 27 Sep 2012 23:22:30 GMT