DRV_MLED_HANDLE_T Struct Reference

The handle of the driver. More...

#include <netx_drv_mled.h>

Collaboration diagram for DRV_MLED_HANDLE_T:

Public Member Functions
DRV_STATUS_E	DRV_MLED_Init (DRV_MLED_HANDLE_T *const ptDriver)
	Initializes the mled device and handle by the given configuration. More...
DRV_STATUS_E	DRV_MLED_DeInit (DRV_MLED_HANDLE_T *const ptDriver)
	Deinitializes the mled device and handle. More...
DRV_STATUS_E	DRV_MLED_ChannelSetMode (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_ID_T uMledID, DRV_MLED_MODE_E eMode)
	Sets the mode of the MLED. More...
DRV_STATUS_E	DRV_MLED_ChannelSetBrightness (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_ID_T uMledID, DRV_MLED_BRIGHTNESS_E uBrightness)
	Sets the brightness of the MLED. More...
DRV_STATUS_E	DRV_MLED_ChannelInvert (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_ID_T uMledID)
	Inverts the MLED. More...
DRV_STATUS_E	DRV_MLED_ChannelOutSet (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_ID_T uMledID)
	Sets the MLED to set. More...
DRV_STATUS_E	DRV_MLED_ChannelOutReset (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_ID_T uMledID)
	Sets the MLED to reset. More...
DRV_STATUS_E	DRV_MLED_LineMaskedSet (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_MSK_T uMask, DRV_MLED_MSK_T uMledMSK)
	Manipulates the mled line and sets the bits given by the mask to the specified value. More...
DRV_STATUS_E	DRV_MLED_LineOutSet (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_MSK_T uMledMSK)
	Manipulates the MLED line and sets the given bits. More...
DRV_STATUS_E	DRV_MLED_LineOutReset (DRV_MLED_HANDLE_T *const ptDriver, DRV_MLED_MSK_T uMledMSK)
	Manipulates the MLED line and resets the given bits. More...

Data Fields
DRV_MLED_CONFIGURATION_T	tConfiguration

Private Attributes
DRV_MLED_DEVICE_T *	ptDevice
DRV_LOCK_T	tLock

Detailed Description

The handle of the driver.

The configuration SHALL be changed before initializing the device and shall not be changed afterwards. The rest of it SHALL not be modified outside of the driver, even if it appears to be possible.

Definition at line 124 of file netx_drv_mled.h.

Field Documentation

DRV_MLED_DEVICE_T* DRV_MLED_HANDLE_T::ptDevice

private

The device register as bitfield and value unions.

Definition at line 126 of file netx_drv_mled.h.

DRV_MLED_CONFIGURATION_T DRV_MLED_HANDLE_T::tConfiguration

Contains the configuration of the device.

Definition at line 127 of file netx_drv_mled.h.

DRV_LOCK_T DRV_MLED_HANDLE_T::tLock

private

The drivers locking variable used as internal mutex.

Definition at line 128 of file netx_drv_mled.h.

---

The documentation for this struct was generated from the following files:

• netx_drv_mled.h
• netx_drv_mled.c