AGHAF 4.5.7
Annecy electronique Generic Hardware Access Framework
Loading...
Searching...
No Matches
aghaf_lin.h File Reference
#include <ghap/aghaf_lin_enums.h>
#include "aghaf_global.h"
Include dependency graph for aghaf_lin.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

typedef void * AGHAF_LIN
 handle on a LIN bus
 
AGHAF_Status AGHAF_LIN_activate (AGHAF_LIN lin)
 Start the communication with the LIN.
 
AGHAF_Status AGHAF_LIN_configureFrame (AGHAF_LIN lin, uint8_t fid, AGHAF_LIN_FrameKind kind, uint8_t publishFlags, uint8_t dataLen, uint8_t const *initialData)
 Configure the frame associated with the frame identifier.
 
AGHAF_Status AGHAF_LIN_deactivate (AGHAF_LIN lin)
 Stop the communication with the LIN.
 
AGHAF_LIN AGHAF_LIN_get (AGHAF_Device device, uint8_t index)
 Return the LIN bus at the index specified.
 
uint8_t AGHAF_LIN_getCount (AGHAF_Device device)
 Return the number of LINs available on a device.
 
uint8_t AGHAF_LIN_getIndex (AGHAF_LIN lin)
 Return the index from a LIN.
 
AGHAF_Status AGHAF_LIN_getParam (AGHAF_LIN lin, AGHAF_LIN_Param param, uint32_t *value)
 Get a parameter from a LIN.
 
AGHAF_Status AGHAF_LIN_isActivated (AGHAF_LIN lin, AGHAF_BOOL *isActivated)
 Allow to know if the communication on the LIN is started or not.
 
typedef void(* AGHAF_LIN_onBusStateChanged) (uint64_t timestamp, AGHAF_LIN_BusState state, void *userContext)
 callback called when a wake up is received
 
typedef void(* AGHAF_LIN_onError) (uint64_t timestamp, AGHAF_LIN_Error error, void *userContext)
 callback called when an error happens on a bus LIN
 
typedef void(* AGHAF_LIN_onMessageRx) (uint64_t timestamp, uint8_t fid, uint8_t datalen, uint8_t const *data, void *userContext)
 callback function called when a message is received on a LIN bus
 
typedef void(* AGHAF_LIN_onMessageTx) (uint64_t timestamp, uint8_t fid, uint8_t datalen, uint8_t const *data, void *userContext)
 callback function called when a message is transmitted on a LIN bus
 
typedef void(* AGHAF_LIN_onWakeUpSent) (uint64_t timestamp, void *userContext)
 callback called when a wake has been sent
 
AGHAF_Status AGHAF_LIN_SCHEDULE_addEventTriggered (AGHAF_LIN lin, uint8_t scheduleIndex, uint8_t timeBaseCount, uint8_t eventTriggerId, uint8_t collisionTable)
 Add an event triggered in a schedule.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_addSporadic (AGHAF_LIN lin, uint8_t scheduleIndex, uint8_t timeBaseCount, uint8_t nbSpo, uint8_t *idList)
 Add a sporadic frame in a schedule.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_addUnconditional (AGHAF_LIN lin, uint8_t scheduleIndex, uint8_t fid, uint8_t timeBaseCount)
 Add an unconditionale frame in a schedule.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_addWakeUp (AGHAF_LIN lin, uint8_t scheduleIndex, uint8_t timeBaseCount)
 Add a wake in a schedule.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_clearDatas (AGHAF_LIN lin, uint8_t scheduleIndex)
 Clear the datas associated to a schedule index.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_configure (AGHAF_LIN lin, uint8_t scheduleIndex, AGHAF_LIN_ScheduleKind kind)
 AGHAF_LIN_SCHEDULE_configure.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_getCount (AGHAF_LIN lin, uint8_t *count)
 Number of LIN schedule that can be configured.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_start (AGHAF_LIN lin, uint8_t scheduleIndex)
 Start a schedule.
 
AGHAF_Status AGHAF_LIN_SCHEDULE_stop (AGHAF_LIN lin)
 Stop the schedule currently executed on the LIN.
 
AGHAF_Status AGHAF_LIN_sendHeader (AGHAF_LIN lin, uint8_t fid)
 Write header on the LIN.
 
void AGHAF_LIN_setOnBusStateChangedCallback (AGHAF_LIN lin, AGHAF_LIN_onBusStateChanged callback, void *userContext)
 Set the callback called on a bus state changed event.
 
void AGHAF_LIN_setOnErrorCallback (AGHAF_LIN lin, AGHAF_LIN_onError callback, void *userContext)
 Set the callback called on an error event.
 
void AGHAF_LIN_setOnMessageRxCallback (AGHAF_LIN lin, AGHAF_LIN_onMessageRx callback, void *userContext)
 Set the callback called on rx event.
 
void AGHAF_LIN_setOnMessageTxCallback (AGHAF_LIN lin, AGHAF_LIN_onMessageTx callback, void *userContext)
 Set the callback called on tx event.
 
void AGHAF_LIN_setOnWakeUpSentCallback (AGHAF_LIN lin, AGHAF_LIN_onWakeUpSent callback, void *userContext)
 Set the callback called on a wake up sent event.
 
AGHAF_Status AGHAF_LIN_setParam (AGHAF_LIN lin, AGHAF_LIN_Param param, uint32_t value)
 Set a parameter from a LIN.
 
AGHAF_Status AGHAF_LIN_updateFrame (AGHAF_LIN lin, uint8_t fid, uint8_t dataLen, uint8_t const *data)
 Update the datas associated to a frame identifier.
 
AGHAF_Status AGHAF_LIN_wakeUp (AGHAF_LIN lin)
 Send a wake up request on the bus LIN.