mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

Embed: (wiki syntax)

« Back to documentation index

Data Structures

Data Structures

Here are the data structures with brief descriptions:
_ARM_DRIVER_STORAGEThis is the set of operations constituting the Storage driver
_ARM_DRIVER_VERSIONDriver Version
_ARM_STORAGE_BLOCKA storage block is a range of memory with uniform attributes
_ARM_STORAGE_BLOCK_ATTRIBUTESAttributes of the storage range within a storage block
_ARM_STORAGE_CAPABILITIESStorage Driver API Capabilities
_ARM_STORAGE_INFOStorage information
_ARM_STORAGE_SECURITY_FEATURESDevice Data Security Protection Features
_ARM_STORAGE_STATUSOperating status of the storage controller
_mbed_error_ctxMbed_error_ctx struct
AnalogInAn analog input, used for reading the voltage on a pin
AnalogOutAn analog output, used for setting the voltage on a pin
ATCmdParserParser class for parsing AT commands
buffer_sGeneric buffer structure
BusInA digital input bus, used for reading the state of a collection of pins
BusInOutA digital input output bus, used for setting the state of a collection of pins
BusOutA digital output bus, used for setting the state of a collection of pins
Callback< R()>Callback class based on template specialization
Callback< R(A0)>Callback class based on template specialization
Callback< R(A0, A1)>Callback class based on template specialization
Callback< R(A0, A1, A2)>Callback class based on template specialization
Callback< R(A0, A1, A2, A3)>Callback class based on template specialization
Callback< R(A0, A1, A2, A3, A4)>Callback class based on template specialization
CallChainGroup one or more functions in an instance of a CallChain, then call them in sequence using CallChain::call()
CANA can bus client, used for communicating with can devices
CAN_MessageHolder for single CAN message
CANMessageCANMessage class
CircularBuffer< T, BufferSize, CounterType >Templated Circular buffer class
CriticalSectionLockRAII object for disabling, then restoring, interrupt state Usage:
CThunk< T >Class for created a pointer with data bound to it
DeepSleepLockRAII object for disabling, then restoring the deep sleep mode Usage:
DigitalInA digital input, used for reading the state of a pin
DigitalInOutA digital input/output, used for setting or reading a bi-directional pin
DigitalOutA digital output, used for setting the state of a pin
DirHandleRepresents a directory stream
EthernetAn ethernet interface, to use with the ethernet pins
FileBaseClass FileBase
FileHandleClass FileHandle
FileLikeClass FileLike
FilePathClass FilePath
FileSystemHandleA filesystem-like object is one that can be used to open file-like objects though it by fopen("/name/filename", mode)
FileSystemLikeA filesystem-like object is one that can be used to open file-like objects though it by fopen("/name/filename", mode)
FlashIAPFlash IAP driver
I2CAn I2C Master, used for communicating with I2C slave devices
i2c_tAsynch I2C HAL structure
I2CSlaveAn I2C Slave, used for communicating with an I2C Master device
InterruptInA digital interrupt input, used to call a function on a rising or falling edge
InterruptManagerUse this singleton if you need to chain interrupt handlers
LocalFileSystemA filesystem for accessing the local mbed Microcontroller USB disk drive
LowPowerTickerLow Power Ticker
LowPowerTimeoutLow Power Timout
LowPowerTimerLow power timer
mbed_stats_cpu_tStruct mbed_stats_cpu_t definition
mbed_stats_heap_tStruct mbed_stats_heap_t definition
mbed_stats_stack_tStruct mbed_stats_stack_t definition
mbed_stats_sys_tStruct mbed_stats_sys_t definition
mbed_stats_thread_tStruct mbed_stats_thread_t definition
MbedCRC< polynomial, width >CRC object provides CRC generation through hardware/software
NonCopyable< T >Inheriting from this class autogeneration of copy construction and copy assignment operations
PlatformMutexA stub mutex for when an RTOS is not present
PortInA multiple pin digital input
PortInOutA multiple pin digital in/out used to set/read multiple bi-directional pins
PortOutA multiple pin digital out
PwmOutA pulse-width modulation digital output
RawSerialA serial port (UART) for communication with other serial devices This is a variation of the Serial class that doesn't use streams, thus making it safe to use in interrupt handlers with the RTOS
ScopedLock< Lockable >RAII-style mechanism for owning a lock of Lockable object for the duration of a scoped block
SerialA serial port (UART) for communication with other serial devices
serial_tAsynch serial HAL structure
SerialBaseA base class for serial port implementations Can't be instantiated directly (use Serial or RawSerial)
SingletonPtr< T >Utility class for creating an using a singleton
SPIA SPI Master, used for communicating with SPI slave devices
spi_tAsynch SPI HAL structure
SPISlaveA SPI slave, used for communicating with a SPI Master device
StreamFile stream
TickerA Ticker is used to call a function at a recurring interval
ticker_data_tTicker's data structure
ticker_event_queue_tTicker's event queue structure
ticker_event_sTicker's event structure
ticker_info_tInformation about the ticker implementation
ticker_interface_tTicker's interface structure - required API for a ticker
TimeoutA Timeout is used to call a function at a point in the future
TimerA general purpose timer
TimerEventBase abstraction for timer interrupts
Transaction< Class >Transaction class defines a transaction
transaction_tTransaction structure
UARTSerialClass providing buffered UART communication functionality using separate circular buffer for send and receive channels