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,
        ACCVIFG
    };
    enum BLKWRT_t// Block write mode {
        BLKWRT_OFF,
        BLKWRT
    };
    enum BUSY_t// Busy {
        BUSY_OFF,
        BUSY
    };
    enum EEIEX_t// Enable Emergency Interrupt Exit {
        EEIEX_OFF,
        EEIEX
    };
    enum EEI_t// Enable Erase Interrupts {
        EEI_OFF,
        EEI
    };
    enum EMEX_t// Emergency exit {
        EMEX_OFF,
        EMEX
    };
    enum ERASE_t// Erase {
        ERASE_OFF,
        ERASE
    };
    enum FAIL_t// Operation failure {
        FAIL_OFF,
        FAIL
    };
    enum FN0_t// Flash controller clock divider bit 0 {
        FN0_OFF,
        FN0
    };
    enum FN1_t// Flash controller clock divider bit 1 {
        FN1_OFF,
        FN1
    };
    enum FN2_t// Flash controller clock divider bit 2 {
        FN2_OFF,
        FN2
    };
    enum FN3_t// Flash controller clock divider bit 3 {
        FN3_OFF,
        FN3
    };
    enum FN4_t// Flash controller clock divider bit 4 {
        FN4_OFF,
        FN4
    };
    enum FN5_t// Flash controller clock divider bit 5 {
        FN5_OFF,
        FN5
    };
    enum FSSEL_t//  {
        FSSEL_0// ACLK,
        FSSEL_1// MCLK,
        FSSEL_2// SMCLK,
        FSSEL_3// SMCLK
    };
    enum FWKEY_t//  {
        FWKEY_OFF,
        FWKEY
    };
    enum KEYV_t// Flash security key violation {
        KEYV_OFF,
        KEYV
    };
    enum LOCKA_t// SegmentA and Info lock {
        LOCKA_OFF,
        LOCKA
    };
    enum LOCK_t// Lock {
        LOCK_OFF,
        LOCK
    };
    enum MERAS_t// Mass erase {
        MERAS_OFF,
        MERAS
    };
    enum WAIT_t// Wait {
        WAIT_OFF,
        WAIT
    };
    enum WRT_t// Write {
        WRT_OFF,
        WRT
    };
    typedef IPeripheral.Instance IPeripheralArray// [];
    typedef String StringArray// [];
    metaonly struct ForceSetDefaultRegister_t// Force Set Default Register {
        String register;
        Bool regForceSet;
    };
module-wide functions
    Void addPeripheralsMap// Create a map of all peripherals available on a device(ICpuDataSheet.Instance cds);
    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 UInt baseAddr// Address of the peripheral's control register;
    config UInt intNum// Interrupt source number;
    config String name// Specific peripheral name given by the device;
    config String owner// String specifying the entity that manages the peripheral;
per-instance creation
    create// Create an instance-object(IClock.Instance clock);
}
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,
    ACCVIFG
};
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,
    BLKWRT
};
enum IFlash.BUSY_t
index URL

Busy

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum BUSY_t {
    BUSY_OFF,
    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,
    EEIEX
};
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,
    EEI
};
enum IFlash.EMEX_t
index URL

Emergency exit

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

Erase

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

Operation failure

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum FAIL_t {
    FAIL_OFF,
    FAIL
};
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,
    FN0
};
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,
    FN1
};
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,
    FN2
};
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,
    FN3
};
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,
    FN4
};
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,
    FN5
};
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
    FSSEL_3
    // 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,
    KEYV
};
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,
    LOCKA
};
enum IFlash.LOCK_t
index URL

Lock

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

Mass erase

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

Wait

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum WAIT_t {
    WAIT_OFF,
    WAIT
};
enum IFlash.WRT_t
index URL

Write

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
enum WRT_t {
    WRT_OFF,
    WRT
};
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.addPeripheralsMap()  // module-wide
index URL

Create a map of all peripherals available on a device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
Void addPeripheralsMap(ICpuDataSheet.Instance cds);
ARGUMENTS
cds — an xdc.platform.ICpuDataSheet instance
DETAILS
The config parameter peripherals is by default undefined in an xdc.platform.ICpuDataSheet instance. This function gathers all instance configuration parameters that are of the type xdc.platform.IPeripheral into the map peripherals.
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.baseAddr  // instance
index URL

Address of the peripheral's control register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
config UInt baseAddr;
DETAILS
A peripheral's registers are commonly accessed through a structure that defines the offsets of a particular register from the lowest address mapped to a peripheral. That lowest address is specified by this parameter.
config IFlash.intNum  // instance
index URL

Interrupt source number

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
config UInt intNum;
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;
Instance Creation
index URL

XDCspec declarations sourced in ti/catalog/msp430/peripherals/memory/IFlash.xdc
create(IClock.Instance clock);
// Create an instance-object
generated on Tue, 24 Aug 2010 15:40:47 GMT