metaonly interface ti.catalog.msp430.peripherals.memory.IFlash
index URL

MSP430 IFlash interface

XDCspec summary sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
metaonly interface IFlash {  ...
// inherits xdc.platform.IPeripheral
instance:  ...
XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
package ti.catalog.msp430.peripherals.memory;
 
metaonly interface IFlash inherits IPeripheral {
module-wide constants & types
    enum ACCVIFG_t// Access violation interrupt flag {
        ACCVIFG_OFF// No interrupt pending,
        ACCVIFG// Interrupt pending
    };
 
    enum BLKWRT_t// Block write mode {
        BLKWRT_OFF// Block-write mode is off,
        BLKWRT// Block-write mode is on
    };
 
    enum BUSY_t// Busy {
        BUSY_OFF// Not Busy,
        BUSY// Busy
    };
 
    enum EEIEX_t// Enable Emergency Interrupt Exit {
        EEIEX_OFF// Exit interrupt disabled,
        EEIEX// Exit interrupt enabled
    };
 
    enum EEI_t// Enable Erase Interrupts {
        EEI_OFF// Interrupts during segment erase disabled,
        EEI// Interrupts during segment erase enabled
    };
 
    enum EMEX_t// Emergency exit {
        EMEX_OFF// No emergency exit,
        EMEX// Emergency exit
    };
 
    enum ERASE_t// Erase {
        ERASE_OFF// Erase disabled,
        ERASE// Erase enabled
    };
 
    enum FAIL_t// Operation failure {
        FAIL_OFF// No failure,
        FAIL// Failure
    };
 
    enum FN0_t// Flash controller clock divider bit 0 {
        FN0_OFF// Flash controller clock divider bit 0,
        FN0// Flash controller clock divider bit 0
    };
 
    enum FN1_t// Flash controller clock divider bit 1 {
        FN1_OFF// Flash controller clock divider bit 1,
        FN1// Flash controller clock divider bit 1
    };
 
    enum FN2_t// Flash controller clock divider bit 2 {
        FN2_OFF// Flash controller clock divider bit 2,
        FN2// Flash controller clock divider bit 2
    };
 
    enum FN3_t// Flash controller clock divider bit 3 {
        FN3_OFF// Flash controller clock divider bit 3,
        FN3// Flash controller clock divider bit 3
    };
 
    enum FN4_t// Flash controller clock divider bit 4 {
        FN4_OFF// Flash controller clock divider bit 4,
        FN4// Flash controller clock divider bit 4
    };
 
    enum FN5_t// Flash controller clock divider bit 5 {
        FN5_OFF// Flash controller clock divider bit 5,
        FN5// Flash controller clock divider bit 5
    };
 
    enum FSSEL_t//  {
        FSSEL_0// ACLK,
        FSSEL_1// MCLK,
        FSSEL_2// SMCLK
    };
 
    enum FWKEY_t//  {
        FWKEY_OFF,
        FWKEY
    };
 
    enum KEYV_t// Flash security key violation {
        KEYV_OFF// FCTLx password was written correctly,
        KEYV// FCTLx password was written incorrectly
    };
 
    enum LOCKA_t// SegmentA and Info lock {
        LOCKA_OFF// Segment A unlocked and all information memory is erased during a mass erase,
        LOCKA// Segment A locked and all information memory is protected from erasure during a mass erase
    };
 
    enum LOCK_t// Lock {
        LOCK_OFF// Unlocked,
        LOCK// Locked
    };
 
    enum MERAS_t// Mass erase {
        MERAS_OFF// Mass erase disabled,
        MERAS// Mass erase enabled
    };
 
    enum WAIT_t// Wait {
        WAIT_OFF// The flash memory is not ready for the next byte/word write,
        WAIT// The flash memory is ready for the next byte/word write
    };
 
    enum WRT_t// Write {
        WRT_OFF// Write mode is off,
        WRT// Write mode is on
    };
 
    typedef IPeripheral.Instance IPeripheralArray// [];
    typedef String StringArray// [];
 
    metaonly struct ForceSetDefaultRegister_t// Force Set Default Register {
        String register;
        Bool regForceSet;
    };
module-wide functions
    IPeripheral.IPeripheralArray getAll// Find all peripherals of a certain type();
    IPeripheral.StringArray getRegisters// Find all registers defined by the peripheral();
 
 
instance:
per-instance config parameters
    config String name// Specific peripheral name given by the device;
    config String owner// String specifying the entity that manages the peripheral;
    config UInt8 uMaxFtg// Max Flash Timing Generator Value from Datasheet;
    config UInt8 uMinFtg// Min Flash Timing Generator Value from Datasheet;
}
 
enum IFlash.ACCVIFG_t
index URL

Access violation interrupt flag

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum ACCVIFG_t {
    ACCVIFG_OFF,
    // No interrupt pending
    ACCVIFG
    // Interrupt pending
};
 
 
enum IFlash.BLKWRT_t
index URL

Block write mode

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum BLKWRT_t {
    BLKWRT_OFF,
    // Block-write mode is off
    BLKWRT
    // Block-write mode is on
};
 
 
enum IFlash.BUSY_t
index URL

Busy

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum BUSY_t {
    BUSY_OFF,
    // Not Busy
    BUSY
    // Busy
};
 
 
enum IFlash.EEIEX_t
index URL

Enable Emergency Interrupt Exit

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum EEIEX_t {
    EEIEX_OFF,
    // Exit interrupt disabled
    EEIEX
    // Exit interrupt enabled
};
 
 
enum IFlash.EEI_t
index URL

Enable Erase Interrupts

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum EEI_t {
    EEI_OFF,
    // Interrupts during segment erase disabled
    EEI
    // Interrupts during segment erase enabled
};
 
 
enum IFlash.EMEX_t
index URL

Emergency exit

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum EMEX_t {
    EMEX_OFF,
    // No emergency exit
    EMEX
    // Emergency exit
};
 
 
enum IFlash.ERASE_t
index URL

Erase

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum ERASE_t {
    ERASE_OFF,
    // Erase disabled
    ERASE
    // Erase enabled
};
 
 
enum IFlash.FAIL_t
index URL

Operation failure

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FAIL_t {
    FAIL_OFF,
    // No failure
    FAIL
    // Failure
};
 
 
enum IFlash.FN0_t
index URL

Flash controller clock divider bit 0

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FN0_t {
    FN0_OFF,
    // Flash controller clock divider bit 0
    FN0
    // Flash controller clock divider bit 0
};
 
 
enum IFlash.FN1_t
index URL

Flash controller clock divider bit 1

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FN1_t {
    FN1_OFF,
    // Flash controller clock divider bit 1
    FN1
    // Flash controller clock divider bit 1
};
 
 
enum IFlash.FN2_t
index URL

Flash controller clock divider bit 2

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FN2_t {
    FN2_OFF,
    // Flash controller clock divider bit 2
    FN2
    // Flash controller clock divider bit 2
};
 
 
enum IFlash.FN3_t
index URL

Flash controller clock divider bit 3

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FN3_t {
    FN3_OFF,
    // Flash controller clock divider bit 3
    FN3
    // Flash controller clock divider bit 3
};
 
 
enum IFlash.FN4_t
index URL

Flash controller clock divider bit 4

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FN4_t {
    FN4_OFF,
    // Flash controller clock divider bit 4
    FN4
    // Flash controller clock divider bit 4
};
 
 
enum IFlash.FN5_t
index URL

Flash controller clock divider bit 5

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FN5_t {
    FN5_OFF,
    // Flash controller clock divider bit 5
    FN5
    // Flash controller clock divider bit 5
};
 
 
enum IFlash.FSSEL_t
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FSSEL_t {
    FSSEL_0,
    // ACLK
    FSSEL_1,
    // MCLK
    FSSEL_2
    // SMCLK
};
 
 
enum IFlash.FWKEY_t
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FWKEY_t {
    FWKEY_OFF,
    FWKEY
};
 
 
enum IFlash.KEYV_t
index URL

Flash security key violation

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum KEYV_t {
    KEYV_OFF,
    // FCTLx password was written correctly
    KEYV
    // FCTLx password was written incorrectly
};
 
 
enum IFlash.LOCKA_t
index URL

SegmentA and Info lock

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum LOCKA_t {
    LOCKA_OFF,
    // Segment A unlocked and all information memory is erased during a mass erase
    LOCKA
    // Segment A locked and all information memory is protected from erasure during a mass erase
};
 
 
enum IFlash.LOCK_t
index URL

Lock

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum LOCK_t {
    LOCK_OFF,
    // Unlocked
    LOCK
    // Locked
};
 
 
enum IFlash.MERAS_t
index URL

Mass erase

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum MERAS_t {
    MERAS_OFF,
    // Mass erase disabled
    MERAS
    // Mass erase enabled
};
 
 
enum IFlash.WAIT_t
index URL

Wait

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum WAIT_t {
    WAIT_OFF,
    // The flash memory is not ready for the next byte/word write
    WAIT
    // The flash memory is ready for the next byte/word write
};
 
 
enum IFlash.WRT_t
index URL

Write

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum WRT_t {
    WRT_OFF,
    // Write mode is off
    WRT
    // Write mode is on
};
 
 
typedef IFlash.IPeripheralArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
typedef IPeripheral.Instance IPeripheralArray[];
 
 
typedef IFlash.StringArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
typedef String StringArray[];
 
 
struct IFlash.ForceSetDefaultRegister_t
index URL

Force Set Default Register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
metaonly struct ForceSetDefaultRegister_t {
    String register;
    Bool regForceSet;
};
 
DETAILS
Type to store if each register needs to be forced initialized even if the register is in default state.
SEE
ForceSetDefaultRegister_t
 
IFlash.getAll()  // module-wide
index URL

Find all peripherals of a certain type

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
IPeripheral.IPeripheralArray getAll();
 
DETAILS
The type of the peripherals returned is defined by the type of the caller.
RETURNS
Returns an array of IPeripheral instances
 
IFlash.getRegisters()  // module-wide
index URL

Find all registers defined by the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
IPeripheral.StringArray getRegisters();
 
RETURNS
Returns an array of register names
 
config IFlash.name  // instance
index URL

Specific peripheral name given by the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
config String name;
 
DETAILS
Devices can have more than one peripheral of the same type. In such cases, device data sheets give different names to the instances of a same peripheral. For example, the name for a timer module could be TimerA3, and a device that has two such timers can name them TA0 and TA1.
 
config IFlash.owner  // instance
index URL

String specifying the entity that manages the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
config String owner;
 
 
config IFlash.uMaxFtg  // instance
index URL

Max Flash Timing Generator Value from Datasheet

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
config UInt8 uMaxFtg;
 
 
config IFlash.uMinFtg  // instance
index URL

Min Flash Timing Generator Value from Datasheet

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
config UInt8 uMinFtg;
 
generated on Thu, 27 Sep 2012 23:24:40 GMT