DHCOM_HAL
Hardware-abstraction library (HAL) for multiple targets, including DHCOM modules
 All Data Structures Namespaces Files Functions Typedefs Enumerations Enumerator Macros Pages
Data Structures | Enumerations
dhcom Namespace Reference

Use this definition if you want the library to support DHCOM-iMX25. More...

Data Structures

class  ADC
 Class provides access to DHCOM module on-board ADC. More...
 
class  GPIO
 Class provides initialization and R/W access to the discrete I/O pins of a DHCOM module. More...
 
class  I2CBus
 Represents an I2C bus of a DHCOM Module. Not available on PC. More...
 
class  I2CSlave
 Class representing a slave device of a I2C bus. This is a convenience class, which simplifies operations with I2C slave devices. It automates the selection of I2C slave in case when several slaves are operating on the same bus. More...
 
class  PhysMem
 Represents a chunk of physical address space of DHCOM module. More...
 
class  SPI
 SPI master device class. The class covers communication with SPI slave devices from DHCOM. The reading and writing happens simultaneously - as the byte is shifted in from the bus, the other byte is shifted out to the bus. The class provides no protection from any simultaneous use of the same SPI port, normally this is done by linux kernel. More...
 
class  System
 Class representing particular HW/SW combination, from which the I/O implementation may depend. More...
 
class  UART
 Provides access to an UART on a DHCOM Module. The class does not provide protection from re-opening the same UART device many times. The class provides non-blocking IO, returning the number of symbols actually sent or received. More...
 

Enumerations

enum  STATUS {
  STATUS_SUCCESS = 0, STATUS_HARDWARE_UNDEFINED, STATUS_HARDWARE_ALREADY_DEFINED, STATUS_HARDWARE_UNSUPPORTED,
  STATUS_DEVICE_DOESNT_EXIST, STATUS_DEVICE_OPEN_FAILED, STATUS_DEVICE_CLOSE_FAILED, STATUS_DEVICE_NOT_OPEN,
  STATUS_DEVICE_ALREADY_OPEN, STATUS_DEVICE_READ_FAILED, STATUS_DEVICE_WRITE_FAILED, STATUS_DEVICE_CONFIG_FAILED,
  STATUS_I2C_SLAVE_SELECT_FAILED
}
 Enumeration for common return codes from library class methods. More...
 

Detailed Description

Use this definition if you want the library to support DHCOM-iMX25.

Use this definition if you want the library to support DHCOM-AM35xx Use this definition if you want the library to support x86 PC

Enumeration Type Documentation

Enumeration for common return codes from library class methods.

Most of the class methods in the library return the STATUS code to reflect the success of the requested operation. This enumeration will be extended as more HAL classes are done.

Enumerator:
STATUS_SUCCESS 

Operation completed successfully.

STATUS_HARDWARE_UNDEFINED 

The target hardware was not defined, create the System object with the hardware type.

STATUS_HARDWARE_ALREADY_DEFINED 

The target hardware was already defined, no way to re-define.

STATUS_HARDWARE_UNSUPPORTED 

The requested target hardware is unsupported by this library built.

STATUS_DEVICE_DOESNT_EXIST 

The requested I/O device does not exist for this target hardware.

STATUS_DEVICE_OPEN_FAILED 

opening I/O device failed

STATUS_DEVICE_CLOSE_FAILED 

closing I/O failed

STATUS_DEVICE_NOT_OPEN 

device must be open to perform the requested operation

STATUS_DEVICE_ALREADY_OPEN 

trying to open the already open device

STATUS_DEVICE_READ_FAILED 

reading from the device failed

STATUS_DEVICE_WRITE_FAILED 

writing to the device failed

STATUS_DEVICE_CONFIG_FAILED 

attempt to configure the device failed (parameters invalid)

STATUS_I2C_SLAVE_SELECT_FAILED 

selecting i2c slave failed