amu_device.h File Reference

#include "amu_commands.h"
#include "amu_types.h"
#include "amu_config_internal.h"

Go to the source code of this file.

Macros
#define	AMU_TWI_DEFAULT_ADDRESS   0x0F
#define	AMU_TWI_ALLCALL_ADDRESS   0x0A
#define	AMU_EYAS_ADDRESS   0x07
#define	AMU_MAX_CONNECTED_DEVICES   16
#define	AMU_DEVICE_STR_LEN   10
#define	AMU_MANUFACTURER_STR_LEN   20
#define	AMU_SERIALNUM_STR_LEN   26
#define	AMU_FIRMWARE_STR_LEN   16
#define	AMU_DEVICE_DEFAULT_STR   "AMU-M0+"
#define	AMU_MANUFACTURER_DEFAULT_STR   "AEROSPACE"
#define	AMU_SERIALNUM_DEFAULT_STR   "0x01"
#define	AMU_FIRMWARE_DEFAULT_STR   "amu-"
#define	AMU_TWI_TRANSFER_READ   1
#define	AMU_TWI_TRANSFER_WRITE   0
#define	__TRANSFER_READ_(TYPE)
#define	__TRANSFER_READ_OFFSET(TYPE)
#define	__TRANSFER_WRITE_(TYPE)
#define	__TRANSFER_WRITE_OFFSET(TYPE)

Functions
volatile amu_device_t *	amu_dev_init (amu_transfer_fptr_t)
	TODO.
int8_t	amu_dev_transfer (uint8_t address, uint8_t reg, uint8_t *data, size_t len, uint8_t rw)
	Transfering... TODO.
uint8_t	amu_dev_busy (uint8_t address)
	Checks to see if the AMU device is busy.
int8_t	amu_dev_send_command (uint8_t address, CMD_t command)
	Sends a command to an AMU device.
int8_t	amu_dev_send_command_data (uint8_t address, CMD_t command, uint8_t len)
	Move local transfer reg to remote transfer reg, then send command.
int8_t	amu_dev_query_command (uint8_t address, CMD_t command, uint8_t commandDataLen, uint8_t responseLength)
	TODO.
static CMD_t	amu_get_next_twi_command (void)
static void	amu_command_complete (void)
uint8_t	amu_scan_for_devices (uint8_t startAddress, uint8_t endAddress)
	Scans for any devices that might be connected in order to identify them.
int8_t	amu_get_num_devices (void)
int8_t	amu_get_num_connected_devices (void)
uint8_t	amu_get_device_address (uint8_t deviceNum)
	Device addresses are used for TODO.
uint8_t	_amu_route_command (uint8_t deviceNum, CMD_t cmd, size_t transferLen, bool query)
	TODO.
void	_amu_transfer_read (size_t offset, void *data, size_t len)
	TODO: explain the transfer part of a transfer read.
void	_amu_transfer_write (size_t offset, void *data, size_t len)
	TODO: explain the transfer part of a transfer write.
volatile uint8_t *	amu_dev_get_transfer_reg_ptr (void)
amu_data_reg_t *	amu_get_register_ptr (uint8_t amu_register)
static uint8_t	transfer_read_uint8_t (void)
static uint16_t	transfer_read_uint16_t (void)
static uint32_t	transfer_read_uint32_t (void)
static int32_t	transfer_read_int32_t (void)
static float	transfer_read_float (void)
static amu_coeff_t	transfer_read_amu_coeff_t (void)
static amu_pid_t	transfer_read_amu_pid_t (void)
static press_data_t	transfer_read_press_data_t (void)
static ss_angle_t	transfer_read_ss_angle_t (void)
static amu_meas_t	transfer_read_amu_meas_t (void)
static uint8_t	transfer_read_offset_uint8_t (void)
static uint16_t	transfer_read_offset_uint16_t (void)
static uint32_t	transfer_read_offset_uint32_t (void)
static int32_t	transfer_read_offset_int32_t (void)
static float	transfer_read_offset_float (void)
static void	transfer_write_uint8_t (uint8_t data)
static void	transfer_write_uint16_t (uint16_t data)
static void	transfer_write_uint32_t (uint32_t data)
static void	transfer_write_int32_t (int32_t data)
static void	transfer_write_float (float data)
static void	transfer_write_amu_coeff_t (amu_coeff_t data)
static void	transfer_write_amu_pid_t (amu_pid_t data)
static void	transfer_write_press_data_t (press_data_t data)
static void	transfer_write_ss_angle_t (ss_angle_t data)
static void	transfer_write_offset_float (uint8_t num, float data)
static void	transfer_write_str (const char *str, uint8_t len)
static void	transfer_read_str (const char *str, uint8_t len)

Variables
volatile amu_device_t	amu_device
char	dev_deviceType_str [10]
char	dev_manufacturer_str [20]
char	dev_serialNumber_str [26]
char	dev_firmware_str [16]

Detailed Description

Author

CJM28241

Date

5/7/2019 3:56:32 PM

Definition in file amu_device.h.

Macro Definition Documentation

__TRANSFER_READ_

#define __TRANSFER_READ_

(

TYPE

)

Value:

static inline TYPE transfer_read_##TYPE(void) { TYPE data; _amu_transfer_read(0, &data, sizeof(TYPE)); return data; }

Definition at line 98 of file amu_device.h.

__TRANSFER_READ_OFFSET

#define __TRANSFER_READ_OFFSET

(

TYPE

)

Value:

static inline TYPE transfer_read_offset_##TYPE(void) { TYPE data; _amu_transfer_read(1, &data, sizeof(TYPE)); return data; }

Definition at line 99 of file amu_device.h.

__TRANSFER_WRITE_

#define __TRANSFER_WRITE_

(

TYPE

)

Value:

static inline void transfer_write_##TYPE(TYPE data)  { _amu_transfer_write(0, &data, sizeof(TYPE)); }

Definition at line 100 of file amu_device.h.

__TRANSFER_WRITE_OFFSET

#define __TRANSFER_WRITE_OFFSET

(

TYPE

)

Value:

static inline void transfer_write_offset_##TYPE(uint8_t num, TYPE data)  { _amu_transfer_write(num*sizeof(TYPE), &data, sizeof(TYPE)); }

Definition at line 101 of file amu_device.h.

AMU_DEVICE_DEFAULT_STR

#define AMU_DEVICE_DEFAULT_STR   "AMU-M0+"

Definition at line 31 of file amu_device.h.

AMU_DEVICE_STR_LEN

#define AMU_DEVICE_STR_LEN   10

Definition at line 26 of file amu_device.h.

AMU_EYAS_ADDRESS

#define AMU_EYAS_ADDRESS   0x07

Definition at line 18 of file amu_device.h.

AMU_FIRMWARE_DEFAULT_STR

#define AMU_FIRMWARE_DEFAULT_STR   "amu-"

Definition at line 34 of file amu_device.h.

AMU_FIRMWARE_STR_LEN

#define AMU_FIRMWARE_STR_LEN   16

Definition at line 29 of file amu_device.h.

AMU_MANUFACTURER_DEFAULT_STR

#define AMU_MANUFACTURER_DEFAULT_STR   "AEROSPACE"

Definition at line 32 of file amu_device.h.

AMU_MANUFACTURER_STR_LEN

#define AMU_MANUFACTURER_STR_LEN   20

Definition at line 27 of file amu_device.h.

AMU_MAX_CONNECTED_DEVICES

#define AMU_MAX_CONNECTED_DEVICES   16

Definition at line 21 of file amu_device.h.

AMU_SERIALNUM_DEFAULT_STR

#define AMU_SERIALNUM_DEFAULT_STR   "0x01"

Definition at line 33 of file amu_device.h.

AMU_SERIALNUM_STR_LEN

#define AMU_SERIALNUM_STR_LEN   26

Definition at line 28 of file amu_device.h.

AMU_TWI_ALLCALL_ADDRESS

#define AMU_TWI_ALLCALL_ADDRESS   0x0A

Definition at line 17 of file amu_device.h.

AMU_TWI_DEFAULT_ADDRESS

#define AMU_TWI_DEFAULT_ADDRESS   0x0F

Definition at line 16 of file amu_device.h.

AMU_TWI_TRANSFER_READ

#define AMU_TWI_TRANSFER_READ   1

Definition at line 36 of file amu_device.h.

AMU_TWI_TRANSFER_WRITE

#define AMU_TWI_TRANSFER_WRITE   0

Definition at line 37 of file amu_device.h.

Function Documentation

_amu_route_command()

uint8_t _amu_route_command	(	uint8_t	deviceNum,
		CMD_t	cmd,
		size_t	transferLen,
		bool	query )

TODO.

TODO

Parameters

deviceNum	TODO
cmd	TODO
transferLen	TODO
query	TODO

Returns

uint8_t TODO

< Root command for I2C/USB commands

< Root command for I2C/USB commands

Definition at line 242 of file amu_device.c.

_amu_transfer_read()

void _amu_transfer_read	(	size_t	offset,
		void *	data,
		size_t	len )

TODO: explain the transfer part of a transfer read.

Parameters

offset	TODO
data	TODO
len	TODO

Definition at line 307 of file amu_device.c.

_amu_transfer_write()

void _amu_transfer_write	(	size_t	offset,
		void *	data,
		size_t	len )

TODO: explain the transfer part of a transfer write.

Parameters

offset	TODO
data	TODO
len	TODO

Definition at line 322 of file amu_device.c.

amu_command_complete()

void amu_command_complete ( void )

inlinestatic

Definition at line 59 of file amu_device.h.

amu_dev_busy()

uint8_t amu_dev_busy

(

uint8_t

address

)

Checks to see if the AMU device is busy.

Parameters

address

TODO

Returns

uint8_t 1 is busy, 0 otherwise

Definition at line 107 of file amu_device.c.

amu_dev_get_transfer_reg_ptr()

volatile uint8_t * amu_dev_get_transfer_reg_ptr

(

void

)

Definition at line 331 of file amu_device.c.

amu_dev_init()

volatile amu_device_t * amu_dev_init

(

amu_transfer_fptr_t

transfer_ptr

)

TODO.

Parameters

amu_device_t

Any AMU device

Definition at line 58 of file amu_device.c.

amu_dev_query_command()

int8_t amu_dev_query_command	(	uint8_t	address,
		CMD_t	command,
		uint8_t	commandDataLen,
		uint8_t	responseLength )

TODO.

Parameters

address	TODO
command	TODO
commandDataLen	TODO
responseLength	TODO

Returns

int8_t

Definition at line 152 of file amu_device.c.

amu_dev_send_command()

int8_t amu_dev_send_command	(	uint8_t	address,
		CMD_t	command )

Sends a command to an AMU device.

Parameters

address	TODO
command	Command for the device

Returns

int8_t TODO

Definition at line 125 of file amu_device.c.

amu_dev_send_command_data()

int8_t amu_dev_send_command_data	(	uint8_t	address,
		CMD_t	command,
		uint8_t	len )

Move local transfer reg to remote transfer reg, then send command.

Parameters

address	TODO
command	Command for the device
len	Length of TODO

Returns

int8_t TODO

Definition at line 137 of file amu_device.c.

amu_dev_transfer()

int8_t amu_dev_transfer	(	uint8_t	address,
		uint8_t	reg,
		uint8_t *	data,
		size_t	len,
		uint8_t	rw )

Transfering... TODO.

Parameters

address	TODO
reg	TODO
data	TODO
len	TODO
rw	TODO

Returns

int8_t

Definition at line 97 of file amu_device.c.

amu_get_device_address()

uint8_t amu_get_device_address

(

uint8_t

deviceNum

)

Device addresses are used for TODO.

Parameters

deviceNum

Device number of interest

Returns

uint8_t Device address

Definition at line 224 of file amu_device.c.

amu_get_next_twi_command()

CMD_t amu_get_next_twi_command ( void )

inlinestatic

< Root command for I2C/USB commands

Definition at line 58 of file amu_device.h.

amu_get_num_connected_devices()

int8_t amu_get_num_connected_devices

(

void

)

Definition at line 214 of file amu_device.c.

amu_get_num_devices()

int8_t amu_get_num_devices

(

void

)

Definition at line 210 of file amu_device.c.

amu_get_register_ptr()

amu_data_reg_t * amu_get_register_ptr

(

uint8_t

amu_register

)

Definition at line 333 of file amu_device.c.

amu_scan_for_devices()

uint8_t amu_scan_for_devices	(	uint8_t	startAddress,
		uint8_t	endAddress )

Scans for any devices that might be connected in order to identify them.

Parameters

startAddress	Start address of the scan range
endAddress	End address of the scan range

Returns

uint8_t Number of devices found, including this device if AMU_DEVICE is defined

Definition at line 179 of file amu_device.c.

transfer_read_amu_coeff_t()

amu_coeff_t transfer_read_amu_coeff_t ( void )

inlinestatic

Definition at line 108 of file amu_device.h.

transfer_read_amu_meas_t()

amu_meas_t transfer_read_amu_meas_t ( void )

inlinestatic

Definition at line 112 of file amu_device.h.

transfer_read_amu_pid_t()

amu_pid_t transfer_read_amu_pid_t ( void )

inlinestatic

Definition at line 109 of file amu_device.h.

transfer_read_float()

float transfer_read_float ( void )

inlinestatic

Definition at line 107 of file amu_device.h.

transfer_read_int32_t()

int32_t transfer_read_int32_t ( void )

inlinestatic

Definition at line 106 of file amu_device.h.

transfer_read_offset_float()

float transfer_read_offset_float ( void )

inlinestatic

Definition at line 118 of file amu_device.h.

transfer_read_offset_int32_t()

int32_t transfer_read_offset_int32_t ( void )

inlinestatic

Definition at line 117 of file amu_device.h.

transfer_read_offset_uint16_t()

uint16_t transfer_read_offset_uint16_t ( void )

inlinestatic

Definition at line 115 of file amu_device.h.

transfer_read_offset_uint32_t()

uint32_t transfer_read_offset_uint32_t ( void )

inlinestatic

Definition at line 116 of file amu_device.h.

transfer_read_offset_uint8_t()

uint8_t transfer_read_offset_uint8_t ( void )

inlinestatic

Definition at line 114 of file amu_device.h.

transfer_read_press_data_t()

press_data_t transfer_read_press_data_t ( void )

inlinestatic

Definition at line 110 of file amu_device.h.

transfer_read_ss_angle_t()

ss_angle_t transfer_read_ss_angle_t ( void )

inlinestatic

Definition at line 111 of file amu_device.h.

transfer_read_str()

void transfer_read_str ( const char * str, uint8_t len )

inlinestatic

Definition at line 133 of file amu_device.h.

transfer_read_uint16_t()

uint16_t transfer_read_uint16_t ( void )

inlinestatic

Definition at line 104 of file amu_device.h.

transfer_read_uint32_t()

uint32_t transfer_read_uint32_t ( void )

inlinestatic

Definition at line 105 of file amu_device.h.

transfer_read_uint8_t()

uint8_t transfer_read_uint8_t ( void )

inlinestatic

Definition at line 103 of file amu_device.h.

transfer_write_amu_coeff_t()

void transfer_write_amu_coeff_t ( amu_coeff_t data )

inlinestatic

Definition at line 125 of file amu_device.h.

transfer_write_amu_pid_t()

void transfer_write_amu_pid_t ( amu_pid_t data )

inlinestatic

Definition at line 126 of file amu_device.h.

transfer_write_float()

void transfer_write_float ( float data )

inlinestatic

Definition at line 124 of file amu_device.h.

transfer_write_int32_t()

void transfer_write_int32_t ( int32_t data )

inlinestatic

Definition at line 123 of file amu_device.h.

transfer_write_offset_float()

void transfer_write_offset_float ( uint8_t num, float data )

inlinestatic

Definition at line 130 of file amu_device.h.

transfer_write_press_data_t()

void transfer_write_press_data_t ( press_data_t data )

inlinestatic

Definition at line 127 of file amu_device.h.

transfer_write_ss_angle_t()

void transfer_write_ss_angle_t ( ss_angle_t data )

inlinestatic

Definition at line 128 of file amu_device.h.

transfer_write_str()

void transfer_write_str ( const char * str, uint8_t len )

inlinestatic

Definition at line 132 of file amu_device.h.

transfer_write_uint16_t()

void transfer_write_uint16_t ( uint16_t data )

inlinestatic

Definition at line 121 of file amu_device.h.

transfer_write_uint32_t()

void transfer_write_uint32_t ( uint32_t data )

inlinestatic

Definition at line 122 of file amu_device.h.

transfer_write_uint8_t()

void transfer_write_uint8_t ( uint8_t data )

inlinestatic

Definition at line 120 of file amu_device.h.

Variable Documentation

amu_device

volatile amu_device_t amu_device

extern

Definition at line 40 of file amu_device.c.

dev_deviceType_str

char dev_deviceType_str[10]

extern

dev_firmware_str

char dev_firmware_str[16]

extern

dev_manufacturer_str

char dev_manufacturer_str[20]

extern

dev_serialNumber_str

char dev_serialNumber_str[26]

extern