AOI:Combinational logic inputs Driver

Overview

This document consists of sections titled with Driver Overview, Data Structures, Enumerations, Functions, etc., each with an overview list and detailed documentation. It is recommended to read the Driver Overview first for it includes a comprehensive description of the peripheral, driver and driver changes. Other sections give detailed information for APIs, enums, macros, etc., for your further reference.

Modules
	AOI Peripheral and Driver Overview
	Content including 1) features; 2) driver design logic and use method; 3) typical use case.
	The Driver Change Log
	The current AOI driver version is 2.0.0.

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

Enumerations
enum	aoi_input_config_t {   kAOI_LogicZero = 0x0U,   kAOI_InputSignal = 0x1U,   kAOI_InvInputSignal = 0x2U,   kAOI_LogicOne = 0x3U }
	AOI input configurations. More...
enum	aoi_event_t {   kAOI_Event0 = 0x0U,   kAOI_Event1 = 0x1U,   kAOI_Event2 = 0x2U,   kAOI_Event3 = 0x3U,   KAOI_EventMax = 0x4U }
	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...

Driver version
#define	FSL_AOI_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))
	Version 2.0.0. More...

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 eEvent, aoi_event_config_t *psEventconfig)
	Gets the Boolean evaluation associated. More...
void	AOI_SetEventLogicConfig (AOI_Type *base, aoi_event_t eEvent, const aoi_event_config_t *psEventconfig)
	Configures an AOI event. More...

---

Data Structure Documentation

struct aoi_event_config_t

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

Data Fields
aoi_input_config_t	PT0AC
	Product term 0 input A.
aoi_input_config_t	PT0BC
	Product term 0 input B.
aoi_input_config_t	PT0CC
	Product term 0 input C.
aoi_input_config_t	PT0DC
	Product term 0 input D.
aoi_input_config_t	PT1AC
	Product term 1 input A.
aoi_input_config_t	PT1BC
	Product term 1 input B.
aoi_input_config_t	PT1CC
	Product term 1 input C.
aoi_input_config_t	PT1DC
	Product term 1 input D.
aoi_input_config_t	PT2AC
	Product term 2 input A.
aoi_input_config_t	PT2BC
	Product term 2 input B.
aoi_input_config_t	PT2CC
	Product term 2 input C.
aoi_input_config_t	PT2DC
	Product term 2 input D.
aoi_input_config_t	PT3AC
	Product term 3 input A.
aoi_input_config_t	PT3BC
	Product term 3 input B.
aoi_input_config_t	PT3CC
	Product term 3 input C.
aoi_input_config_t	PT3DC
	Product term 3 input D.

Macro Definition Documentation

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

Enumeration Type Documentation

enum aoi_input_config_t

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.

enum aoi_event_t

Enumerator
kAOI_Event0	Event 0 index.
kAOI_Event1	Event 1 index.
kAOI_Event2	Event 2 index.
kAOI_Event3	Event 3 index.
KAOI_EventMax	Max event.

Function Documentation

void AOI_Init

(

AOI_Type *

base

)

Reserved function, enable clock preparation.

Parameters

base	AOI peripheral address.

void AOI_Deinit

(

AOI_Type *

base

)

Reserved function, disable clock preparation.

Parameters

base	AOI peripheral address.

void AOI_GetEventLogicConfig	(	AOI_Type *	base,
		aoi_event_t	eEvent,
		aoi_event_config_t *	psEventconfig
	)

This function returns the Boolean evaluation associated.

Example:

aoi_event_config_t demoEventLogicStruct;

AOI_GetEventLogicConfig(AOI, kAOI_Event0, &demoEventLogicStruct);

Parameters

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

void AOI_SetEventLogicConfig	(	AOI_Type *	base,
		aoi_event_t	eEvent,
		const aoi_event_config_t *	psEventconfig
	)

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.
eEvent	Event which will be configured of type aoi_event_t.
psEventconfig	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.