module ti.mcu.msp430.runtime.utils.Led

index URL

Simple LED manager

C synopsis
Individual elements
XDCscript usage
Individual elements

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

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

Functions
Void	Led_off// Turn specified LED off(Bits8 mask);
Void	Led_on// Turn specified LED on(Bits8 mask);
Void	Led_toggle// Toggle the state of specified LED(Bits8 mask);
Functions common to all target modules
	Led_Module_getMask// Returns the diagnostics mask for this module, Led_Module_hasMask// Test whether this module has a diagnostics mask, Led_Module_heap// The heap from which this module allocates memory, Led_Module_id// Get this module's unique id, Led_Module_setMask// Set the diagnostics mask for this module, Led_Module_startupDone// Test if this module has completed startup
Defines
#define	Led_PORT0// (Ptr)0x11
#define	Led_PORT0DIR// (Ptr)0x12
#define	Led_PORT1// (Ptr)0x21
#define	Led_PORT1DIR// (Ptr)0x22
#define	Led_PORT2// (Ptr)0x29
#define	Led_PORT2DIR// (Ptr)0x2A
#define	Led_PORT3// (Ptr)0x19
#define	Led_PORT3DIR// (Ptr)0x1A
#define	Led_PORT4// (Ptr)0x1D
#define	Led_PORT4DIR// (Ptr)0x1E
#define	Led_PORT5// (Ptr)0x31
#define	Led_PORT5DIR// (Ptr)0x32
#define	Led_PORT6// (Ptr)0x35
#define	Led_PORT6DIR// (Ptr)0x36
#define	Led_PORT7// (Ptr)0x3A
#define	Led_PORT7DIR// (Ptr)0x3C
#define	Led_PORT8// (Ptr)0x3B
#define	Led_PORT8DIR// (Ptr)0x3D
#define	Led_PORTADIR_H// (Ptr)0x205
#define	Led_PORTADIR_L// (Ptr)0x204
#define	Led_PORTA_H// (Ptr)0x203
#define	Led_PORTA_L// (Ptr)0x202
#define	Led_PORTBDIR_H// (Ptr)0x225
#define	Led_PORTBDIR_L// (Ptr)0x224
#define	Led_PORTB_H// (Ptr)0x223
#define	Led_PORTB_L// (Ptr)0x222
#define	Led_PORTCDIR_H// (Ptr)0x245
#define	Led_PORTCDIR_L// (Ptr)0x244
#define	Led_PORTC_H// (Ptr)0x243
#define	Led_PORTC_L// (Ptr)0x242
#define	Led_PORTDDIR_H// (Ptr)0x265
#define	Led_PORTDDIR_L// (Ptr)0x264
#define	Led_PORTD_H// (Ptr)0x263
#define	Led_PORTD_L// (Ptr)0x262
#define	Led_PORTEDIR_H// (Ptr)0x285
#define	Led_PORTEDIR_L// (Ptr)0x284
#define	Led_PORTE_H// (Ptr)0x283
#define	Led_PORTE_L// (Ptr)0x282
#define	Led_PORTFDIR_L// (Ptr)0x2A4
#define	Led_PORTF_L// (Ptr)0x2A2
Constants
extern const Ptr	Led_DIRCFG// Address of GPIO configuration register;
extern const Bits8	Led_GREEN// Port mask for a green LED;
extern const Ptr	Led_PORT// Address of 8-bit output port to use;
extern const Bits8	Led_RED// Port mask for a red LED;

const Led_PORT0

index URL

C synopsis target-domain

#define Led_PORT0 (Ptr)0x11

const Led_PORT0DIR

index URL

C synopsis target-domain

#define Led_PORT0DIR (Ptr)0x12

const Led_PORT1

index URL

C synopsis target-domain

#define Led_PORT1 (Ptr)0x21

const Led_PORT1DIR

index URL

C synopsis target-domain

#define Led_PORT1DIR (Ptr)0x22

const Led_PORT2

index URL

C synopsis target-domain

#define Led_PORT2 (Ptr)0x29

const Led_PORT2DIR

index URL

C synopsis target-domain

#define Led_PORT2DIR (Ptr)0x2A

const Led_PORT3

index URL

C synopsis target-domain

#define Led_PORT3 (Ptr)0x19

const Led_PORT3DIR

index URL

C synopsis target-domain

#define Led_PORT3DIR (Ptr)0x1A

const Led_PORT4

index URL

C synopsis target-domain

#define Led_PORT4 (Ptr)0x1D

const Led_PORT4DIR

index URL

C synopsis target-domain

#define Led_PORT4DIR (Ptr)0x1E

const Led_PORT5

index URL

C synopsis target-domain

#define Led_PORT5 (Ptr)0x31

const Led_PORT5DIR

index URL

C synopsis target-domain

#define Led_PORT5DIR (Ptr)0x32

const Led_PORT6

index URL

C synopsis target-domain

#define Led_PORT6 (Ptr)0x35

const Led_PORT6DIR

index URL

C synopsis target-domain

#define Led_PORT6DIR (Ptr)0x36

const Led_PORT7

index URL

C synopsis target-domain

#define Led_PORT7 (Ptr)0x3A

const Led_PORT7DIR

index URL

C synopsis target-domain

#define Led_PORT7DIR (Ptr)0x3C

const Led_PORT8

index URL

C synopsis target-domain

#define Led_PORT8 (Ptr)0x3B

const Led_PORT8DIR

index URL

C synopsis target-domain

#define Led_PORT8DIR (Ptr)0x3D

const Led_PORTADIR_H

index URL

C synopsis target-domain

#define Led_PORTADIR_H (Ptr)0x205

const Led_PORTADIR_L

index URL

C synopsis target-domain

#define Led_PORTADIR_L (Ptr)0x204

const Led_PORTA_H

index URL

C synopsis target-domain

#define Led_PORTA_H (Ptr)0x203

const Led_PORTA_L

index URL

C synopsis target-domain

#define Led_PORTA_L (Ptr)0x202

const Led_PORTBDIR_H

index URL

C synopsis target-domain

#define Led_PORTBDIR_H (Ptr)0x225

const Led_PORTBDIR_L

index URL

C synopsis target-domain

#define Led_PORTBDIR_L (Ptr)0x224

const Led_PORTB_H

index URL

C synopsis target-domain

#define Led_PORTB_H (Ptr)0x223

const Led_PORTB_L

index URL

C synopsis target-domain

#define Led_PORTB_L (Ptr)0x222

const Led_PORTCDIR_H

index URL

C synopsis target-domain

#define Led_PORTCDIR_H (Ptr)0x245

const Led_PORTCDIR_L

index URL

C synopsis target-domain

#define Led_PORTCDIR_L (Ptr)0x244

const Led_PORTC_H

index URL

C synopsis target-domain

#define Led_PORTC_H (Ptr)0x243

const Led_PORTC_L

index URL

C synopsis target-domain

#define Led_PORTC_L (Ptr)0x242

const Led_PORTDDIR_H

index URL

C synopsis target-domain

#define Led_PORTDDIR_H (Ptr)0x265

const Led_PORTDDIR_L

index URL

C synopsis target-domain

#define Led_PORTDDIR_L (Ptr)0x264

const Led_PORTD_H

index URL

C synopsis target-domain

#define Led_PORTD_H (Ptr)0x263

const Led_PORTD_L

index URL

C synopsis target-domain

#define Led_PORTD_L (Ptr)0x262

const Led_PORTEDIR_H

index URL

C synopsis target-domain

#define Led_PORTEDIR_H (Ptr)0x285

const Led_PORTEDIR_L

index URL

C synopsis target-domain

#define Led_PORTEDIR_L (Ptr)0x284

const Led_PORTE_H

index URL

C synopsis target-domain

#define Led_PORTE_H (Ptr)0x283

const Led_PORTE_L

index URL

C synopsis target-domain

#define Led_PORTE_L (Ptr)0x282

const Led_PORTFDIR_L

index URL

C synopsis target-domain

#define Led_PORTFDIR_L (Ptr)0x2A4

const Led_PORTF_L

index URL

C synopsis target-domain

#define Led_PORTF_L (Ptr)0x2A2

config Led_DIRCFG // module-wide

index URL

Address of GPIO configuration register

C synopsis target-domain

extern const Ptr Led_DIRCFG;

config Led_GREEN // module-wide

index URL

Port mask for a green LED

C synopsis target-domain

extern const Bits8 Led_GREEN;

config Led_PORT // module-wide

index URL

Address of 8-bit output port to use

C synopsis target-domain

extern const Ptr Led_PORT;

config Led_RED // module-wide

index URL

Port mask for a red LED

C synopsis target-domain

extern const Bits8 Led_RED;

Led_off() // module-wide

index URL

Turn specified LED off

C synopsis target-domain

Void Led_off(Bits8 mask);

Led_on() // module-wide

index URL

Turn specified LED on

C synopsis target-domain

Void Led_on(Bits8 mask);

Led_toggle() // module-wide

index URL

Toggle the state of specified LED

C synopsis target-domain

Void Led_toggle(Bits8 mask);

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId Led_Module_id();

// Get this module's unique id

Bool Led_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle Led_Module_heap();

// The heap from which this module allocates memory

Bool Led_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 Led_Module_getMask();

// Returns the diagnostics mask for this module

Void Led_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

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

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

module-wide constants & types

const Led.PORT0// = 0x11;

const Led.PORT0DIR// = 0x12;

const Led.PORT1// = 0x21;

const Led.PORT1DIR// = 0x22;

const Led.PORT2// = 0x29;

const Led.PORT2DIR// = 0x2A;

const Led.PORT3// = 0x19;

const Led.PORT3DIR// = 0x1A;

const Led.PORT4// = 0x1D;

const Led.PORT4DIR// = 0x1E;

const Led.PORT5// = 0x31;

const Led.PORT5DIR// = 0x32;

const Led.PORT6// = 0x35;

const Led.PORT6DIR// = 0x36;

const Led.PORT7// = 0x3A;

const Led.PORT7DIR// = 0x3C;

const Led.PORT8// = 0x3B;

const Led.PORT8DIR// = 0x3D;

const Led.PORTADIR_H// = 0x205;

const Led.PORTADIR_L// = 0x204;

const Led.PORTA_H// = 0x203;

const Led.PORTA_L// = 0x202;

const Led.PORTBDIR_H// = 0x225;

const Led.PORTBDIR_L// = 0x224;

const Led.PORTB_H// = 0x223;

const Led.PORTB_L// = 0x222;

const Led.PORTCDIR_H// = 0x245;

const Led.PORTCDIR_L// = 0x244;

const Led.PORTC_H// = 0x243;

const Led.PORTC_L// = 0x242;

const Led.PORTDDIR_H// = 0x265;

const Led.PORTDDIR_L// = 0x264;

const Led.PORTD_H// = 0x263;

const Led.PORTD_L// = 0x262;

const Led.PORTEDIR_H// = 0x285;

const Led.PORTEDIR_L// = 0x284;

const Led.PORTE_H// = 0x283;

const Led.PORTE_L// = 0x282;

const Led.PORTFDIR_L// = 0x2A4;

const Led.PORTF_L// = 0x2A2;

module-wide config parameters

Led.DIRCFG// Address of GPIO configuration register = Ptr Led.PORT1DIR;

Led.GREEN// Port mask for a green LED = Bits8 0x2;

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

Led.RED// Port mask for a red LED = Bits8 0x1;

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

const Led.PORT0

index URL

XDCscript usage meta-domain

const Led.PORT0 = 0x11;

C SYNOPSIS

Led_PORT0

const Led.PORT0DIR

index URL

XDCscript usage meta-domain

const Led.PORT0DIR = 0x12;

C SYNOPSIS

Led_PORT0DIR

const Led.PORT1

index URL

XDCscript usage meta-domain

const Led.PORT1 = 0x21;

C SYNOPSIS

Led_PORT1

const Led.PORT1DIR

index URL

XDCscript usage meta-domain

const Led.PORT1DIR = 0x22;

C SYNOPSIS

Led_PORT1DIR

const Led.PORT2

index URL

XDCscript usage meta-domain

const Led.PORT2 = 0x29;

C SYNOPSIS

Led_PORT2

const Led.PORT2DIR

index URL

XDCscript usage meta-domain

const Led.PORT2DIR = 0x2A;

C SYNOPSIS

Led_PORT2DIR

const Led.PORT3

index URL

XDCscript usage meta-domain

const Led.PORT3 = 0x19;

C SYNOPSIS

Led_PORT3

const Led.PORT3DIR

index URL

XDCscript usage meta-domain

const Led.PORT3DIR = 0x1A;

C SYNOPSIS

Led_PORT3DIR

const Led.PORT4

index URL

XDCscript usage meta-domain

const Led.PORT4 = 0x1D;

C SYNOPSIS

Led_PORT4

const Led.PORT4DIR

index URL

XDCscript usage meta-domain

const Led.PORT4DIR = 0x1E;

C SYNOPSIS

Led_PORT4DIR

const Led.PORT5

index URL

XDCscript usage meta-domain

const Led.PORT5 = 0x31;

C SYNOPSIS

Led_PORT5

const Led.PORT5DIR

index URL

XDCscript usage meta-domain

const Led.PORT5DIR = 0x32;

C SYNOPSIS

Led_PORT5DIR

const Led.PORT6

index URL

XDCscript usage meta-domain

const Led.PORT6 = 0x35;

C SYNOPSIS

Led_PORT6

const Led.PORT6DIR

index URL

XDCscript usage meta-domain

const Led.PORT6DIR = 0x36;

C SYNOPSIS

Led_PORT6DIR

const Led.PORT7

index URL

XDCscript usage meta-domain

const Led.PORT7 = 0x3A;

C SYNOPSIS

Led_PORT7

const Led.PORT7DIR

index URL

XDCscript usage meta-domain

const Led.PORT7DIR = 0x3C;

C SYNOPSIS

Led_PORT7DIR

const Led.PORT8

index URL

XDCscript usage meta-domain

const Led.PORT8 = 0x3B;

C SYNOPSIS

Led_PORT8

const Led.PORT8DIR

index URL

XDCscript usage meta-domain

const Led.PORT8DIR = 0x3D;

C SYNOPSIS

Led_PORT8DIR

const Led.PORTADIR_H

index URL

XDCscript usage meta-domain

const Led.PORTADIR_H = 0x205;

C SYNOPSIS

Led_PORTADIR_H

const Led.PORTADIR_L

index URL

XDCscript usage meta-domain

const Led.PORTADIR_L = 0x204;

C SYNOPSIS

Led_PORTADIR_L

const Led.PORTA_H

index URL

XDCscript usage meta-domain

const Led.PORTA_H = 0x203;

C SYNOPSIS

Led_PORTA_H

const Led.PORTA_L

index URL

XDCscript usage meta-domain

const Led.PORTA_L = 0x202;

C SYNOPSIS

Led_PORTA_L

const Led.PORTBDIR_H

index URL

XDCscript usage meta-domain

const Led.PORTBDIR_H = 0x225;

C SYNOPSIS

Led_PORTBDIR_H

const Led.PORTBDIR_L

index URL

XDCscript usage meta-domain

const Led.PORTBDIR_L = 0x224;

C SYNOPSIS

Led_PORTBDIR_L

const Led.PORTB_H

index URL

XDCscript usage meta-domain

const Led.PORTB_H = 0x223;

C SYNOPSIS

Led_PORTB_H

const Led.PORTB_L

index URL

XDCscript usage meta-domain

const Led.PORTB_L = 0x222;

C SYNOPSIS

Led_PORTB_L

const Led.PORTCDIR_H

index URL

XDCscript usage meta-domain

const Led.PORTCDIR_H = 0x245;

C SYNOPSIS

Led_PORTCDIR_H

const Led.PORTCDIR_L

index URL

XDCscript usage meta-domain

const Led.PORTCDIR_L = 0x244;

C SYNOPSIS

Led_PORTCDIR_L

const Led.PORTC_H

index URL

XDCscript usage meta-domain

const Led.PORTC_H = 0x243;

C SYNOPSIS

Led_PORTC_H

const Led.PORTC_L

index URL

XDCscript usage meta-domain

const Led.PORTC_L = 0x242;

C SYNOPSIS

Led_PORTC_L

const Led.PORTDDIR_H

index URL

XDCscript usage meta-domain

const Led.PORTDDIR_H = 0x265;

C SYNOPSIS

Led_PORTDDIR_H

const Led.PORTDDIR_L

index URL

XDCscript usage meta-domain

const Led.PORTDDIR_L = 0x264;

C SYNOPSIS

Led_PORTDDIR_L

const Led.PORTD_H

index URL

XDCscript usage meta-domain

const Led.PORTD_H = 0x263;

C SYNOPSIS

Led_PORTD_H

const Led.PORTD_L

index URL

XDCscript usage meta-domain

const Led.PORTD_L = 0x262;

C SYNOPSIS

Led_PORTD_L

const Led.PORTEDIR_H

index URL

XDCscript usage meta-domain

const Led.PORTEDIR_H = 0x285;

C SYNOPSIS

Led_PORTEDIR_H

const Led.PORTEDIR_L

index URL

XDCscript usage meta-domain

const Led.PORTEDIR_L = 0x284;

C SYNOPSIS

Led_PORTEDIR_L

const Led.PORTE_H

index URL

XDCscript usage meta-domain

const Led.PORTE_H = 0x283;

C SYNOPSIS

Led_PORTE_H

const Led.PORTE_L

index URL

XDCscript usage meta-domain

const Led.PORTE_L = 0x282;

C SYNOPSIS

Led_PORTE_L

const Led.PORTFDIR_L

index URL

XDCscript usage meta-domain

const Led.PORTFDIR_L = 0x2A4;

C SYNOPSIS

Led_PORTFDIR_L

const Led.PORTF_L

index URL

XDCscript usage meta-domain

const Led.PORTF_L = 0x2A2;

C SYNOPSIS

Led_PORTF_L

config Led.DIRCFG // module-wide

index URL

Address of GPIO configuration register

XDCscript usage meta-domain

Led.DIRCFG = Ptr Led.PORT1DIR;

C SYNOPSIS

Led_DIRCFG

config Led.GREEN // module-wide

index URL

Port mask for a green LED

XDCscript usage meta-domain

Led.GREEN = Bits8 0x2;

C SYNOPSIS

Led_GREEN

config Led.PORT // module-wide

index URL

Address of 8-bit output port to use

XDCscript usage meta-domain

Led.PORT = Ptr Led.PORT1;

C SYNOPSIS

Led_PORT

config Led.RED // module-wide

index URL

Port mask for a red LED

XDCscript usage meta-domain

Led.RED = Bits8 0x1;

C SYNOPSIS

Led_RED

metaonly config Led.common$ // module-wide

index URL

Common module configuration parameters

XDCscript usage meta-domain

Led.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