MICA2 Magnet
[Device Drivers]

Defines
#define	dev_open_DEV_MICA2_MAGNET_X()   mos_mutex_lock(&magnet_x_mutex)
	gain an exclusive lock on the Magnet. Any other threads calling dev_open_DEV_MICA2_MAGNET_[X/Y]() will block until the owner calls dev_close_DEV_MICA2_MAGNET_[X/Y]().
#define	dev_close_DEV_MICA2_MAGNET_X()   mos_mutex_unlock(&magnet_x_mutex)
	release exclusive lock on the Magnet. Any other thread blocking on dev_open_DEV_MICA2_MAGNET_[X/Y]() will now unblock.
#define	dev_open_DEV_MICA2_MAGNET_Y()   mos_mutex_lock(&magnet_y_mutex)
	gain an exclusive lock on the Magnet. Any other threads calling dev_open_DEV_MICA2_MAGNET_[X/Y]() will block until the owner calls dev_close_DEV_MICA2_MAGNET_[X/Y]().
#define	dev_close_DEV_MICA2_MAGNET_Y()   mos_mutex_unlock(&magnet_y_mutex)
	release exclusive lock on the Magnet. Any other thread blocking on dev_open_DEV_MICA2_MAGNET_[X/Y]() will now unblock.
Functions
uint16_t	dev_read_DEV_MICA2_MAGNET_X (void *buf, uint16_t count)
	read data from the Magnet (X-direction) into buf.
uint16_t	dev_write_DEV_MICA2_MAGNET_X (const void *buf, uint16_t count)
	unsupported for the MICA2 Magnet Driver.
uint8_t	dev_mode_DEV_MICA2_MAGNET_X (uint8_t md)
	turn the MICA2 Magnet on or off. Accepted parameters are: DEV_MODE_OFF: Turn the device off. DEV_MODE_ON: Turn the device on.
uint8_t	dev_ioctl_DEV_MICA2_MAGNET_X (int8_t request,...)
	unsupported for the MICA2 Magnet Driver.
uint16_t	dev_read_DEV_MICA2_MAGNET_Y (void *buf, uint16_t count)
	read data from the Magnet (Y-direction) into buf.
uint16_t	dev_write_DEV_MICA2_MAGNET_Y (const void *buf, uint16_t count)
	unsupported for the MICA2 Magnet Driver.
uint8_t	dev_mode_DEV_MICA2_MAGNET_Y (uint8_t md)
	turn the MICA2 Magnet on or off. Accepted parameters are: DEV_MODE_OFF: Turn the device off. DEV_MODE_ON: Turn the device on.
uint8_t	dev_ioctl_DEV_MICA2_MAGNET_Y (int8_t request,...)
	unsupported for the MICA2 Magnet Driver.
Variables
mos_mutex_t	magnet_x_mutex
mos_mutex_t	magnet_y_mutex

---

Detailed Description

This group contains functions associated with the MICA Magnet This applies to the MICAz/MICA2 platform.

---

Function Documentation

uint8_t dev_ioctl_DEV_MICA2_MAGNET_X (  int8_t  request,   ... )

Parameters: request  ignored ...  ignored Returns: DEV_BAD_IOCTL

uint8_t dev_ioctl_DEV_MICA2_MAGNET_Y (  int8_t  request,   ... )

Parameters: request  ignored ...  ignored Returns: DEV_BAD_IOCTL

uint8_t dev_mode_DEV_MICA2_MAGNET_X (  uint8_t  md  )

Parameters: md  the new mode Returns: DEV_OK or DEV_UNSUPPORTED

uint8_t dev_mode_DEV_MICA2_MAGNET_Y (  uint8_t  md  )

Parameters: md  the new mode Returns: DEV_OK or DEV_UNSUPPORTED

uint16_t dev_read_DEV_MICA2_MAGNET_X (  void *  buf, uint16_t  count )

Parameters: count  either '2' to read a 16-bit value, or '1' to read an 8-bit value. Any other value will return DEV_UNSUPPORTED. buf  the buffer to hold the data. Returns: number of bytes read ('1' or '2')

uint16_t dev_read_DEV_MICA2_MAGNET_Y (  void *  buf, uint16_t  count )

Parameters: count  either '2' to read a 16-bit value, or '1' to read an 8-bit value. Any other value will return DEV_UNSUPPORTED. buf  the buffer to hold the data. Returns: number of bytes read ('1' or '2')

uint16_t dev_write_DEV_MICA2_MAGNET_X (  const void *  buf, uint16_t  count )

Parameters: buf  ignored count  ignored Returns: DEV_UNSUPPORTED

uint16_t dev_write_DEV_MICA2_MAGNET_Y (  const void *  buf, uint16_t  count )

Parameters: buf  ignored count  ignored Returns: DEV_UNSUPPORTED

---

Variable Documentation

mos_mutex_t magnet_x_mutex

For internal use only. Used by the dev_open and dev_close functions.

mos_mutex_t magnet_y_mutex

For internal use only. Used by the dev_open and dev_close functions.

---