Interface: tos.chips.msp430.adc12.HplAdc12

interface HplAdc12

The HplAdc12 interface exports low-level access to the ADC12 registers of the MSP430 MCU.

Author:
Jan Hauer
See:
Please refer to TEP 101 for more information about this component and its intended use.

Commands
command void enableConversion() Enables conversion (sets the ENC bit).
command adc12ctl0_t getCtl0() Returns the ADC12 control register ADC12CTL0.
command adc12ctl1_t getCtl1() Returns the ADC12 control register ADC12CTL1.
command uint16_t getIEFlags() Returns the ADC12 interrupt enable register, ADC12IE.
command adc12memctl_t getMCtl(uint8_t idx) Returns the ADC12 conversion memory control register ADC12MCTLx.
command uint16_t getMem(uint8_t idx) Returns the ADC12 conversion memory register ADC12MEMx.
command bool isBusy() Returns the ADC12 BUSY flag.
command void resetIFGs() Resets the ADC12 interrupt flag register, ADC12IFG.
command void setCtl0(adc12ctl0_t control0) Sets the ADC12 control register ADC12CTL0.
command void setCtl1(adc12ctl1_t control1) Sets the ADC12 control register ADC12CTL1.
command void setIEFlags(uint16_t mask) Sets the ADC12 interrupt enable register, ADC12IE.
command void setMCtl(uint8_t idx, adc12memctl_t memControl) Sets the ADC12 conversion memory control register ADC12MCTLx.
command void startConversion() Starts a conversion.
command void stopConversion() Stops a conversion.

Events
event void conversionDone(uint16_t iv) Signals a conversion result.

Commands - Details

enableConversion

command void enableConversion()

Enables conversion (sets the ENC bit).

getCtl0

command adc12ctl0_t getCtl0()

Returns the ADC12 control register ADC12CTL0.

Returns:
ADC12CTL0 *

getCtl1

command adc12ctl1_t getCtl1()

Returns the ADC12 control register ADC12CTL1.

Returns:
ADC12CTL1 *

getIEFlags

command uint16_t getIEFlags()

Returns the ADC12 interrupt enable register, ADC12IE.

Returns:
ADC12IE

getMCtl

command adc12memctl_t getMCtl(uint8_t idx)

Returns the ADC12 conversion memory control register ADC12MCTLx.

Parameters:
idx - The register index (the 'x' in ADC12MCTLx) [0..15]
Returns:
memControl ADC12MCTLx register data.

getMem

command uint16_t getMem(uint8_t idx)

Returns the ADC12 conversion memory register ADC12MEMx.

Parameters:
idx - The register index (the 'x' in ADC12MEMx) [0..15]
Returns:
ADC12MEMx

isBusy

command bool isBusy()

Returns the ADC12 BUSY flag.

Returns:
ADC12BUSY

resetIFGs

command void resetIFGs()

Resets the ADC12 interrupt flag register, ADC12IFG.

setCtl0

command void setCtl0(adc12ctl0_t control0)

Sets the ADC12 control register ADC12CTL0.

Parameters:
control0 - ADC12CTL0 register data. *

setCtl1

command void setCtl1(adc12ctl1_t control1)

Sets the ADC12 control register ADC12CTL1.

Parameters:
control1 - ADC12CTL1 register data. *

setIEFlags

command void setIEFlags(uint16_t mask)

Sets the ADC12 interrupt enable register, ADC12IE.

Parameters:
mask - Bitmask (0 means interrupt disabled, 1 menas interrupt enabled)

setMCtl

command void setMCtl(uint8_t idx, adc12memctl_t memControl)

Sets the ADC12 conversion memory control register ADC12MCTLx.

Parameters:
idx - The register index (the 'x' in ADC12MCTLx) [0..15]
memControl - ADC12MCTLx register data.

startConversion

command void startConversion()

Starts a conversion.

stopConversion

command void stopConversion()

Stops a conversion.

Events - Details

conversionDone

event void conversionDone(uint16_t iv)

Signals a conversion result.

Parameters:
iv - ADC12 interrupt vector value 0x6, 0x8, ... , 0x24