Aoi

Data Structures
struct	_aoi_event_config
	AOI event configuration structure. More...

Macros
#define	AOI   AOI0

Variables
aoi_input_config_t	_aoi_event_config::PT0AC
aoi_input_config_t	_aoi_event_config::PT0BC
aoi_input_config_t	_aoi_event_config::PT0CC
aoi_input_config_t	_aoi_event_config::PT0DC
aoi_input_config_t	_aoi_event_config::PT1AC
aoi_input_config_t	_aoi_event_config::PT1BC
aoi_input_config_t	_aoi_event_config::PT1CC
aoi_input_config_t	_aoi_event_config::PT1DC
aoi_input_config_t	_aoi_event_config::PT2AC
aoi_input_config_t	_aoi_event_config::PT2BC
aoi_input_config_t	_aoi_event_config::PT2CC
aoi_input_config_t	_aoi_event_config::PT2DC
aoi_input_config_t	_aoi_event_config::PT3AC
aoi_input_config_t	_aoi_event_config::PT3BC
aoi_input_config_t	_aoi_event_config::PT3CC
aoi_input_config_t	_aoi_event_config::PT3DC

Driver version
enum	_aoi_input_config { kAOI_LogicZero = 0x0U , kAOI_InputSignal = 0x1U , kAOI_InvInputSignal = 0x2U , kAOI_LogicOne = 0x3U }
	AOI input configurations. More...
enum	_aoi_event { kAOI_Event0 = 0x0U , kAOI_Event1 = 0x1U , kAOI_Event2 = 0x2U , kAOI_Event3 = 0x3U }
	AOI event indexes, where an event is the collection of the four product terms (0, 1, 2, and 3) and the four signal inputs (A, B, C, and D). More...
typedef enum _aoi_input_config	aoi_input_config_t
	AOI input configurations. More...
typedef enum _aoi_event	aoi_event_t
	AOI event indexes, where an event is the collection of the four product terms (0, 1, 2, and 3) and the four signal inputs (A, B, C, and D).
typedef struct _aoi_event_config	aoi_event_config_t
	AOI event configuration structure. More...
#define	FSL_AOI_DRIVER_VERSION   (MAKE_VERSION(2, 0, 1))

AOI Initialization
void	AOI_Init (AOI_Type *base)
	Initializes an AOI instance for operation. More...
void	AOI_Deinit (AOI_Type *base)
	Deinitializes an AOI instance for operation. More...

AOI Get Set Operation
void	AOI_GetEventLogicConfig (AOI_Type *base, aoi_event_t event, aoi_event_config_t *config)
	Gets the Boolean evaluation associated. More...
void	AOI_SetEventLogicConfig (AOI_Type *base, aoi_event_t event, const aoi_event_config_t *eventConfig)
	Configures an AOI event. More...

Detailed Description

Macro Definition Documentation

AOI

#define AOI   AOI0

AOI peripheral address

FSL_AOI_DRIVER_VERSION

#define FSL_AOI_DRIVER_VERSION   (MAKE_VERSION(2, 0, 1))

Version 2.0.1.

Typedef Documentation

aoi_event_config_t

typedef struct _aoi_event_config aoi_event_config_t

AOI event configuration structure.

Defines structure _aoi_event_config and use the AOI_SetEventLogicConfig() function to make whole event configuration.

aoi_input_config_t

typedef enum _aoi_input_config aoi_input_config_t

AOI input configurations.

The selection item represents the Boolean evaluations.

Enumeration Type Documentation

_aoi_event

enum _aoi_event

AOI event indexes, where an event is the collection of the four product terms (0, 1, 2, and 3) and the four signal inputs (A, B, C, and D).

Enumerator
kAOI_Event0	Event 0 index
kAOI_Event1	Event 1 index
kAOI_Event2	Event 2 index
kAOI_Event3	Event 3 index

_aoi_input_config

enum _aoi_input_config

AOI input configurations.

The selection item represents the Boolean evaluations.

Enumerator
kAOI_LogicZero	Forces the input to logical zero.
kAOI_InputSignal	Passes the input signal.
kAOI_InvInputSignal	Inverts the input signal.
kAOI_LogicOne	Forces the input to logical one.

Function Documentation

AOI_Deinit()

void AOI_Deinit

(

AOI_Type *

base

)

Deinitializes an AOI instance for operation.

This function shutdowns AOI module.

Parameters

base	AOI peripheral address.

brief Deinitializes an AOI instance for operation.

This function shutdowns AOI module.

param base AOI peripheral address.

AOI_GetEventLogicConfig()

void AOI_GetEventLogicConfig	(	AOI_Type *	base,
		aoi_event_t	event,
		aoi_event_config_t *	config
	)

Gets the Boolean evaluation associated.

This function returns the Boolean evaluation associated.

Example:

aoi_event_config_t demoEventLogicStruct;
 
AOI_GetEventLogicConfig(AOI, kAOI_Event0, &demoEventLogicStruct);

Parameters

base	AOI peripheral address.
event	Index of the event which will be set of type aoi_event_t.
config	Selected input configuration .

brief Gets the Boolean evaluation associated.

This function returns the Boolean evaluation associated.

Example: code aoi_event_config_t demoEventLogicStruct;

AOI_GetEventLogicConfig(AOI, kAOI_Event0, &demoEventLogicStruct); endcode

param base AOI peripheral address. param event Index of the event which will be set of type aoi_event_t. param config Selected input configuration .

AOI_Init()

void AOI_Init

(

AOI_Type *

base

)

Initializes an AOI instance for operation.

This function un-gates the AOI clock.

Parameters

base	AOI peripheral address.

brief Initializes an AOI instance for operation.

This function un-gates the AOI clock.

param base AOI peripheral address.

AOI_SetEventLogicConfig()

void AOI_SetEventLogicConfig	(	AOI_Type *	base,
		aoi_event_t	event,
		const aoi_event_config_t *	eventConfig
	)

Configures an AOI event.

This function configures an AOI event according to the aoiEventConfig structure. This function configures all inputs (A, B, C, and D) of all product terms (0, 1, 2, and 3) of a desired event.

Example:

aoi_event_config_t demoEventLogicStruct;
 
demoEventLogicStruct.PT0AC = kAOI_InvInputSignal;
demoEventLogicStruct.PT0BC = kAOI_InputSignal;
demoEventLogicStruct.PT0CC = kAOI_LogicOne;
demoEventLogicStruct.PT0DC = kAOI_LogicOne;
 
demoEventLogicStruct.PT1AC = kAOI_LogicZero;
demoEventLogicStruct.PT1BC = kAOI_LogicOne;
demoEventLogicStruct.PT1CC = kAOI_LogicOne;
demoEventLogicStruct.PT1DC = kAOI_LogicOne;
 
demoEventLogicStruct.PT2AC = kAOI_LogicZero;
demoEventLogicStruct.PT2BC = kAOI_LogicOne;
demoEventLogicStruct.PT2CC = kAOI_LogicOne;
demoEventLogicStruct.PT2DC = kAOI_LogicOne;
 
demoEventLogicStruct.PT3AC = kAOI_LogicZero;
demoEventLogicStruct.PT3BC = kAOI_LogicOne;
demoEventLogicStruct.PT3CC = kAOI_LogicOne;
demoEventLogicStruct.PT3DC = kAOI_LogicOne;
 
AOI_SetEventLogicConfig(AOI, kAOI_Event0, demoEventLogicStruct);

Parameters

base	AOI peripheral address.
event	Event which will be configured of type aoi_event_t.
eventConfig	Pointer to type aoi_event_config_t structure. The user is responsible for filling out the members of this structure and passing the pointer to this function.

brief Configures an AOI event.

This function configures an AOI event according to the aoiEventConfig structure. This function configures all inputs (A, B, C, and D) of all product terms (0, 1, 2, and 3) of a desired event.

Example: code aoi_event_config_t demoEventLogicStruct;

demoEventLogicStruct.PT0AC = kAOI_InvInputSignal; demoEventLogicStruct.PT0BC = kAOI_InputSignal; demoEventLogicStruct.PT0CC = kAOI_LogicOne; demoEventLogicStruct.PT0DC = kAOI_LogicOne;

demoEventLogicStruct.PT1AC = kAOI_LogicZero; demoEventLogicStruct.PT1BC = kAOI_LogicOne; demoEventLogicStruct.PT1CC = kAOI_LogicOne; demoEventLogicStruct.PT1DC = kAOI_LogicOne;

demoEventLogicStruct.PT2AC = kAOI_LogicZero; demoEventLogicStruct.PT2BC = kAOI_LogicOne; demoEventLogicStruct.PT2CC = kAOI_LogicOne; demoEventLogicStruct.PT2DC = kAOI_LogicOne;

demoEventLogicStruct.PT3AC = kAOI_LogicZero; demoEventLogicStruct.PT3BC = kAOI_LogicOne; demoEventLogicStruct.PT3CC = kAOI_LogicOne; demoEventLogicStruct.PT3DC = kAOI_LogicOne;

AOI_SetEventLogicConfig(AOI, kAOI_Event0, demoEventLogicStruct); endcode

param base AOI peripheral address. param event Event which will be configured of type aoi_event_t. param eventConfig Pointer to type aoi_event_config_t structure. The user is responsible for filling out the members of this structure and passing the pointer to this function.

Variable Documentation

PT0AC

aoi_input_config_t _aoi_event_config::PT0AC

Product term 0 input A

PT0BC

aoi_input_config_t _aoi_event_config::PT0BC

Product term 0 input B

PT0CC

aoi_input_config_t _aoi_event_config::PT0CC

Product term 0 input C

PT0DC

aoi_input_config_t _aoi_event_config::PT0DC

Product term 0 input D

PT1AC

aoi_input_config_t _aoi_event_config::PT1AC

Product term 1 input A

PT1BC

aoi_input_config_t _aoi_event_config::PT1BC

Product term 1 input B

PT1CC

aoi_input_config_t _aoi_event_config::PT1CC

Product term 1 input C

PT1DC

aoi_input_config_t _aoi_event_config::PT1DC

Product term 1 input D

PT2AC

aoi_input_config_t _aoi_event_config::PT2AC

Product term 2 input A

PT2BC

aoi_input_config_t _aoi_event_config::PT2BC

Product term 2 input B

PT2CC

aoi_input_config_t _aoi_event_config::PT2CC

Product term 2 input C

PT2DC

aoi_input_config_t _aoi_event_config::PT2DC

Product term 2 input D

PT3AC

aoi_input_config_t _aoi_event_config::PT3AC

Product term 3 input A

PT3BC

aoi_input_config_t _aoi_event_config::PT3BC

Product term 3 input B

PT3CC

aoi_input_config_t _aoi_event_config::PT3CC

Product term 3 input C

PT3DC

aoi_input_config_t _aoi_event_config::PT3DC

Product term 3 input D