Refs #316. Completed implementation of the Peak PCAN-USB interface module.

git-svn-id: https://svn.code.sf.net/p/openblt/code/trunk@312 5dc33758-31d5-4daf-9ae8-b24bf3d40d73
This commit is contained in:
Frank Voorburg 2017-07-26 09:59:15 +00:00
parent 6f7b2381d1
commit 3696d4674b
4 changed files with 1178 additions and 415 deletions

View File

@ -185,6 +185,32 @@ bool CanTransmit(tCanMsg const * msg)
} /*** end of CanTransmit ***/
/************************************************************************************//**
** \brief Checks if a bus off or bus heavy situation occurred.
** \return True if a bus error situation was detected, false otherwise.
**
****************************************************************************************/
bool CanIsBusError(void)
{
bool result = false;
/* Make sure a valid CAN interface is linked. */
assert(canIfPtr != NULL);
/* Only continue with a valid CAN interface. */
if (canIfPtr != NULL) /*lint !e774 */
{
/* Only check for bus error if connected. */
if (canConnected)
{
result = canIfPtr->IsBusError();
}
}
/* Give the result back to the caller. */
return result;
} /*** end of CanIsBusError ***/
/************************************************************************************//**
** \brief Registers the event callback functions that should be called by the CAN
** module.

View File

@ -90,13 +90,13 @@ typedef struct t_can_msg
* .mask = 0x00000000
* Example 2: Receive only CAN identifier 0x124 (11-bit or 29-bit)
* .code = 0x00000124
* .mask = 0x00000124
* .mask = 0x1fffffff
* Example 3: Receive only CAN identifier 0x124 (11-bit)
* .code = 0x00000124
* .mask = 0x80000124
* .mask = 0x9fffffff
* Example 4: Receive only CAN identifier 0x124 (29-bit)
* .code = 0x80000124
* .mask = 0x80000124
* .mask = 0x9fffffff
*/
typedef struct t_can_settings
{
@ -129,6 +129,8 @@ typedef struct t_can_interface
void (*Disconnect) (void);
/** \brief Submits a CAN message for transmission. */
bool (*Transmit) (tCanMsg const * msg);
/** \brief Check if a bus off and/or bus heavy situation occurred. */
bool (*IsBusError) (void);
/** \brief Registers the event callback functions. */
void (*RegisterEvents) (tCanEvents const * events);
} tCanInterface;
@ -143,6 +145,7 @@ bool CanConnect(void);
void CanDisconnect(void);
bool CanIsConnected(void);
bool CanTransmit(tCanMsg const * msg);
bool CanIsBusError(void);
void CanRegisterEvents(tCanEvents const * events);
#ifdef __cplusplus

View File

@ -41,15 +41,47 @@
#include "PCANBasic.h" /* for PCAN-Basic API */
/***************************************************************************************
* Type definitions
****************************************************************************************/
/* Type definitions of the function in the PCAN-Basic API that this CAN interface uses.*/
typedef TPCANStatus (__stdcall * tPCanUsbLibFuncInitialize)(TPCANHandle, TPCANBaudrate, TPCANType, DWORD, WORD);
typedef TPCANStatus (__stdcall * tPCanUsbLibFuncpUninitialize)(TPCANHandle);
typedef TPCANStatus (__stdcall * tPCanUsbLibFuncGetStatus)(TPCANHandle);
typedef TPCANStatus (__stdcall * tPCanUsbLibFuncSetValue)(TPCANHandle, TPCANParameter, void*, DWORD);
typedef TPCANStatus (__stdcall * tPCanUsbLibFuncRead)(TPCANHandle, TPCANMsg*, TPCANTimestamp*);
typedef TPCANStatus (__stdcall * tPCanUsbLibFuncWrite)(TPCANHandle, TPCANMsg*);
typedef TPCANStatus (__stdcall * tPCanUsbLibFuncFilterMessages)(TPCANHandle, DWORD, DWORD, TPCANMode);
/***************************************************************************************
* Function prototypes
****************************************************************************************/
/* CAN interface functions. */
static void PCanUsbInit(tCanSettings const * settings);
static void PCanUsbTerminate(void);
static bool PCanUsbConnect(void);
static void PCanUsbDisconnect(void);
static bool PCanUsbTransmit(tCanMsg const * msg);
static bool PCanUsbIsBusError(void);
static void PCanUsbRegisterEvents(tCanEvents const * events);
/* CAN message reception thread. */
static DWORD WINAPI PCanUsbReceptionThread(LPVOID pv);
/* PCAN-Basic library handling. */
static void PCanUsbLibLoadDll(void);
static void PCanUsbLibUnloadDll(void);
static TPCANStatus PCanUsbLibFuncInitialize(TPCANHandle Channel, TPCANBaudrate Btr0Btr1,
TPCANType HwType, DWORD IOPort,
WORD Interrupt);
static TPCANStatus PCanUsbLibFuncpUninitialize(TPCANHandle Channel);
static TPCANStatus PCanUsbLibFuncGetStatus(TPCANHandle Channel);
static TPCANStatus PCanUsbLibFuncSetValue(TPCANHandle Channel, TPCANParameter Parameter,
void * Buffer, DWORD BufferLength);
static TPCANStatus PCanUsbLibFuncRead(TPCANHandle Channel, TPCANMsg * MessageBuffer,
TPCANTimestamp * TimestampBuffer);
static TPCANStatus PCanUsbLibFuncWrite(TPCANHandle Channel, TPCANMsg * MessageBuffer);
static TPCANStatus PCanUsbLibFuncFilterMessages(TPCANHandle Channel, DWORD FromID,
DWORD ToID, TPCANMode Mode);
/****************************************************************************************
@ -63,9 +95,33 @@ static const tCanInterface pCanUsbInterface =
PCanUsbConnect,
PCanUsbDisconnect,
PCanUsbTransmit,
PCanUsbIsBusError,
PCanUsbRegisterEvents
};
/** \brief PCAN-USB channel handle lookup table. The pCanUsbSettings.channel value can
* be used as the index.
*/
static const TPCANHandle pCanUsbChannelLookup[] =
{
PCAN_USBBUS1, /* PCAN-USB interface, channel 1. */
PCAN_USBBUS2, /* PCAN-USB interface, channel 2. */
PCAN_USBBUS3, /* PCAN-USB interface, channel 3. */
PCAN_USBBUS4, /* PCAN-USB interface, channel 4. */
PCAN_USBBUS5, /* PCAN-USB interface, channel 5. */
PCAN_USBBUS6, /* PCAN-USB interface, channel 6. */
PCAN_USBBUS7, /* PCAN-USB interface, channel 7. */
PCAN_USBBUS8, /* PCAN-USB interface, channel 8. */
PCAN_USBBUS9, /* PCAN-USB interface, channel 9. */
PCAN_USBBUS10, /* PCAN-USB interface, channel 10. */
PCAN_USBBUS11, /* PCAN-USB interface, channel 11. */
PCAN_USBBUS12, /* PCAN-USB interface, channel 12. */
PCAN_USBBUS13, /* PCAN-USB interface, channel 13. */
PCAN_USBBUS14, /* PCAN-USB interface, channel 14. */
PCAN_USBBUS15, /* PCAN-USB interface, channel 15. */
PCAN_USBBUS16 /* PCAN-USB interface, channel 16. */
};
/****************************************************************************************
* Local data declarations
@ -79,6 +135,39 @@ static tCanEvents * pCanUsbEventsList;
/** \brief Total number of event entries into the \ref pCanUsbEventsList list. */
static uint32_t pCanUsbEventsEntries;
/** \brief Handle to the PCAN-Basic dynamic link library. */
static HINSTANCE pCanUsbDllHandle;
/** \brief Function pointer to the PCAN-Basic Initialize function. */
static tPCanUsbLibFuncInitialize pCanUsbLibFuncInitializePtr;
/** \brief Function pointer to the PCAN-Basic Uninitialize function. */
static tPCanUsbLibFuncpUninitialize pCanUsbLibFuncpUninitializePtr;
/** \brief Function pointer to the PCAN-Basic GetStatus function. */
static tPCanUsbLibFuncGetStatus pCanUsbLibFuncGetStatusPtr;
/** \brief Function pointer to the PCAN-Basic SetValue function. */
static tPCanUsbLibFuncSetValue pCanUsbLibFuncSetValuePtr;
/** \brief Function pointer to the PCAN-Basic Read function. */
static tPCanUsbLibFuncRead pCanUsbLibFuncReadPtr;
/** \brief Function pointer to the PCAN-Basic Write function. */
static tPCanUsbLibFuncWrite pCanUsbLibFuncWritePtr;
/** \brief Function pointer to the PCAN-Basic FilterMessages function. */
static tPCanUsbLibFuncFilterMessages pCanUsbLibFuncFilterMessagesPtr;
/** \brief Handle for the event to terminate the reception thread. */
static HANDLE pCanUsbTerminateEvent;
/** \brief Handle for a CAN related event. */
static HANDLE pCanUsbCanEvent;
/** \brief Handle for the CAN reception thread. */
static HANDLE pCanUsbRxThreadHandle;
/***********************************************************************************//**
** \brief Obtains a pointer to the CAN interface structure, so that it can be linked
@ -104,6 +193,18 @@ static void PCanUsbInit(tCanSettings const * settings)
/* Initialize locals. */
pCanUsbEventsList = NULL;
pCanUsbEventsEntries = 0;
pCanUsbTerminateEvent = NULL;
pCanUsbCanEvent = NULL;
pCanUsbRxThreadHandle = NULL;
pCanUsbDllHandle = NULL;
/* Reset library function pointers. */
pCanUsbLibFuncInitializePtr = NULL;
pCanUsbLibFuncpUninitializePtr = NULL;
pCanUsbLibFuncGetStatusPtr = NULL;
pCanUsbLibFuncSetValuePtr = NULL;
pCanUsbLibFuncReadPtr = NULL;
pCanUsbLibFuncWritePtr = NULL;
pCanUsbLibFuncFilterMessagesPtr = NULL;
/* Reset CAN interface settings. */
pCanUsbSettings.devicename = "";
pCanUsbSettings.channel = 0;
@ -133,8 +234,9 @@ static void PCanUsbInit(tCanSettings const * settings)
pCanUsbSettings.devicename = canDeviceName;
}
}
/* Perform initialization of PCAN-Basic API. */
PCanUsbLibLoadDll();
}
/* ##Vg TODO Perform initialization of PCAN-Basic API. */
} /*** end of PCanUsbInit ***/
@ -144,7 +246,8 @@ static void PCanUsbInit(tCanSettings const * settings)
****************************************************************************************/
static void PCanUsbTerminate(void)
{
/* ##Vg TODO Perform termination of PCAN-Basic API. */
/* Perform termination of PCAN-Basic API. */
PCanUsbLibUnloadDll();
/* Release memory that was allocated for storing the device name. */
if (pCanUsbSettings.devicename != NULL)
{
@ -173,10 +276,196 @@ static void PCanUsbTerminate(void)
static bool PCanUsbConnect(void)
{
bool result = false;
bool baudrateSupported = true;
bool channelSupported;
bool libInitialized = false;
TPCANBaudrate baudrate = PCAN_BAUD_500K;
uint32_t iBuffer;
/* ##Vg TODO Check CAN interface settings. */
/* Convert the baudrate to a value supported by the PCAN-Basic API. */
switch (pCanUsbSettings.baudrate)
{
case CAN_BR10K:
baudrate = PCAN_BAUD_10K;
break;
case CAN_BR20K:
baudrate = PCAN_BAUD_20K;
break;
case CAN_BR50K:
baudrate = PCAN_BAUD_50K;
break;
case CAN_BR100K:
baudrate = PCAN_BAUD_100K;
break;
case CAN_BR125K:
baudrate = PCAN_BAUD_125K;
break;
case CAN_BR250K:
baudrate = PCAN_BAUD_250K;
break;
case CAN_BR500K:
baudrate = PCAN_BAUD_500K;
break;
case CAN_BR800K:
baudrate = PCAN_BAUD_800K;
break;
case CAN_BR1M:
baudrate = PCAN_BAUD_1M;
break;
default:
baudrateSupported = false;
break;
}
/* ##Vg TODO Connect to CAN interface, if settings are valid. */
/* Validate channel index. For this CAN interface, the channel index specifies the
* PCAN-USB device, in case multiple are connected.
*/
channelSupported = (pCanUsbSettings.channel < (sizeof(pCanUsbChannelLookup) /
sizeof(pCanUsbChannelLookup[0])));
/* Note that the device name itself is not needed anymore at this point, it was only
* needed by the CAN driver to link the correct interface (this one). Check settings.
*/
assert(baudrateSupported);
assert(channelSupported);
/* Only continue with valid settings. */
if ( (baudrateSupported) && (channelSupported) )
{
/* Init result code to success and only negate it on detection of error. */
result = true;
/* Connect to the CAN hardware interface. */
if (PCanUsbLibFuncInitialize(pCanUsbChannelLookup[pCanUsbSettings.channel],
baudrate, 0, 0, 0) != PCAN_ERROR_OK)
{
result = false;
}
else
{
libInitialized = true;
}
/* Create the terminate event handle used in the reception thread. */
if (result)
{
pCanUsbTerminateEvent = CreateEvent(NULL, TRUE, FALSE, "");
if (pCanUsbTerminateEvent == NULL)
{
result = false;
}
}
/* Create the CAN event handle used in the reception thread. */
if (result)
{
pCanUsbCanEvent = CreateEvent(NULL, FALSE, FALSE, "");
if (pCanUsbCanEvent == NULL)
{
result = false;
}
}
/* Enable the bus off auto reset. */
if (result)
{
iBuffer = PCAN_PARAMETER_ON;
if (PCanUsbLibFuncSetValue(pCanUsbChannelLookup[pCanUsbSettings.channel],
PCAN_BUSOFF_AUTORESET, &iBuffer,
sizeof(iBuffer)) != PCAN_ERROR_OK)
{
result = false;
}
}
/* Configure reception acceptance filter, if it is not supposed to be fully open. */
if ( (result) && (pCanUsbSettings.mask != 0x00000000u) )
{
/* Configuration of the reception acceptance filter in the PCAN-Basic library does
* not use a mask and code approach. Instead it has an API function for setting
* the filter by specifing an identifier range. This means the mask and code pair
* should be used to calculate the lowest and highest identifier that should pass
* the filter. It is not 100% accurate. In some cases more identifiers can pass
* the filter than desired, but there is no other option:
* Lowest CAN ID = (code & mask) & 0x1fffffff
* Highest CAN ID = (code | ~mask) & 0x1fffffff
*/
uint32_t lowestCanID = (pCanUsbSettings.code & pCanUsbSettings.mask) & 0x1fffffffu;
uint32_t highestCanID = (pCanUsbSettings.code | ~pCanUsbSettings.mask) & 0x1fffffffu;
/* Use bit logic to determine if the filter should accept standard 11-bit and/or
* extended 29-bit identifiers:
* acceptStdId = ((mask & code & CAN_MSG_EXT_ID_MASK) == 0)
* acceptExtId = ((mask & code & CAN_MSG_EXT_ID_MASK) != 0) ||
* ((mask & CAN_MSG_EXT_ID_MASK) == 0)
*/
bool acceptStdID = ((pCanUsbSettings.mask & pCanUsbSettings.code & CAN_MSG_EXT_ID_MASK) == 0);
bool acceptExtID = ((pCanUsbSettings.mask & pCanUsbSettings.code & CAN_MSG_EXT_ID_MASK) != 0) ||
((pCanUsbSettings.mask & CAN_MSG_EXT_ID_MASK) == 0);
/* Configure acceptance filter for standard 11-bit identifiers. */
if (acceptStdID)
{
if (PCanUsbLibFuncFilterMessages(pCanUsbChannelLookup[pCanUsbSettings.channel],
lowestCanID, highestCanID,
PCAN_MODE_STANDARD) != PCAN_ERROR_OK)
{
result = false;
}
}
/* Configure acceptance filter for extended 29-bit identifiers. */
if ( (acceptExtID) && (result) )
{
if (PCanUsbLibFuncFilterMessages(pCanUsbChannelLookup[pCanUsbSettings.channel],
lowestCanID, highestCanID,
PCAN_MODE_EXTENDED) != PCAN_ERROR_OK)
{
result = false;
}
}
}
/* Register the event reception handle. */
if (result)
{
if (PCanUsbLibFuncSetValue(pCanUsbChannelLookup[pCanUsbSettings.channel],
PCAN_RECEIVE_EVENT, &pCanUsbCanEvent,
sizeof(pCanUsbCanEvent)) != PCAN_ERROR_OK)
{
result = false;
}
}
/* Start the reception thread as the last step. */
if (result)
{
pCanUsbRxThreadHandle = CreateThread(NULL, 0, PCanUsbReceptionThread,
NULL, 0, NULL);
if (pCanUsbRxThreadHandle == NULL)
{
result = false;
}
}
}
/* Clean-up in case an error occurred. */
if (!result)
{
if (libInitialized)
{
/* Uninitialize the library. */
(void)PCanUsbLibFuncpUninitialize(pCanUsbChannelLookup[pCanUsbSettings.channel]);
}
if (pCanUsbTerminateEvent != NULL)
{
/* Close the event handle. */
(void)CloseHandle(pCanUsbTerminateEvent);
pCanUsbTerminateEvent = NULL;
}
if (pCanUsbCanEvent != NULL)
{
/* Close the event handle. */
(void)CloseHandle(pCanUsbCanEvent);
pCanUsbCanEvent = NULL;
}
}
/* Give the result back to the caller. */
return result;
@ -189,7 +478,31 @@ static bool PCanUsbConnect(void)
****************************************************************************************/
static void PCanUsbDisconnect(void)
{
/* ##Vg TODO Disconnect from the CAN interface. */
/* Stop the reception thread. */
if (pCanUsbRxThreadHandle != NULL)
{
/* Trigger event to request the reception thread to stop. */
(void)SetEvent(pCanUsbTerminateEvent);
/* Wait for the thread to signal termination. */
(void)WaitForSingleObject(pCanUsbRxThreadHandle, INFINITE);
/* Close the thread handle. */
(void)CloseHandle(pCanUsbRxThreadHandle);
}
/* Close the terminate event handle. */
if (pCanUsbTerminateEvent != NULL)
{
(void)CloseHandle(pCanUsbTerminateEvent);
pCanUsbTerminateEvent = NULL;
}
/* Close the CAN event handle. */
if (pCanUsbCanEvent != NULL)
{
(void)CloseHandle(pCanUsbCanEvent);
pCanUsbCanEvent = NULL;
}
/* Disconnect from the CAN interface. */
(void)PCanUsbLibFuncpUninitialize(pCanUsbChannelLookup[pCanUsbSettings.channel]);
} /*** end of PCanUsbDisconnect ***/
@ -202,6 +515,8 @@ static void PCanUsbDisconnect(void)
static bool PCanUsbTransmit(tCanMsg const * msg)
{
bool result = false;
TPCANMsg msgBuf;
tCanEvents const * pEvents;
/* Check parameters. */
assert(msg != NULL);
@ -209,14 +524,73 @@ static bool PCanUsbTransmit(tCanMsg const * msg)
/* Only continue with valid parameters. */
if (msg != NULL) /*lint !e774 */
{
/* ##Vg TODO Submit CAN message for transmission */
}
/* Convert the message to a type supported by the PCAN-Basic API. */
if ((msg->id & CAN_MSG_EXT_ID_MASK) == 0)
{
msgBuf.ID = msg->id & 0x7ffu;
msgBuf.MSGTYPE = PCAN_MESSAGE_STANDARD;
}
else
{
msgBuf.ID = msg->id & 0x1fffffffu;
msgBuf.MSGTYPE = PCAN_MESSAGE_EXTENDED;
}
msgBuf.LEN = msg->dlc;
for (uint8_t idx = 0; idx < msgBuf.LEN; idx++)
{
msgBuf.DATA[idx] = msg->data[idx];
}
/* Submit CAN message for transmission. */
if (PCanUsbLibFuncWrite(pCanUsbChannelLookup[pCanUsbSettings.channel],
&msgBuf) == PCAN_ERROR_OK)
{
/* Update result value to success. */
result = true;
/* Trigger transmit complete event(s). */
pEvents = pCanUsbEventsList;
for (uint32_t idx = 0; idx < pCanUsbEventsEntries; idx++)
{
if (pEvents != NULL)
{
if (pEvents->MsgTxed != NULL)
{
pEvents->MsgTxed(msg);
}
/* Move on to the next entry in the list. */
pEvents++;
}
}
}
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbTransmit ***/
/************************************************************************************//**
** \brief Checks if a bus off or bus heavy situation occurred.
** \return True if a bus error situation was detected, false otherwise.
**
****************************************************************************************/
static bool PCanUsbIsBusError(void)
{
bool result = false;
TPCANStatus status;
/* Obtain the status information. */
status = PCanUsbLibFuncGetStatus(pCanUsbChannelLookup[pCanUsbSettings.channel]);
/* Process the status to detect bus off or bus heavy. */
if ((status == PCAN_ERROR_BUSOFF) || (status == PCAN_ERROR_BUSHEAVY))
{
result = true;
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbIsBusError ***/
/************************************************************************************//**
** \brief Registers the event callback functions that should be called by the CAN
** interface.
@ -228,8 +602,6 @@ static void PCanUsbRegisterEvents(tCanEvents const * events)
/* Check parameters. */
assert(events != NULL);
/* ##Vg TODO Test with multiple event entries to check that realloc approach works. */
/* Only continue with valid parameters. */
if (events != NULL) /*lint !e774 */
{
@ -259,5 +631,367 @@ static void PCanUsbRegisterEvents(tCanEvents const * events)
} /*** end of PCanUsbRegisterEvents ***/
/************************************************************************************//**
** \brief CAN message reception thread.
** \param pv Pointer to thread parameters.
** \return Thread exit code.
**
****************************************************************************************/
static DWORD WINAPI PCanUsbReceptionThread(LPVOID pv)
{
DWORD waitResult;
HANDLE handles[] =
{
pCanUsbCanEvent,
pCanUsbTerminateEvent
};
bool running = true;
TPCANMsg rxLibMsg;
tCanMsg rxMsg;
tCanEvents const * pEvents;
/* Parameter not used. */
(void)pv;
/* Enter thread's infinite loop. */
while (running)
{
waitResult = WaitForMultipleObjects(sizeof(handles)/sizeof(handles[0]), handles,
FALSE, INFINITE);
switch (waitResult)
{
/* CAN reception event. */
case WAIT_OBJECT_0 + 0: /*lint !e835 */
/* Empty out the queue with received events. */
while (PCanUsbLibFuncRead(pCanUsbChannelLookup[pCanUsbSettings.channel],
&rxLibMsg, NULL) == PCAN_ERROR_OK)
{
/* Only process events that contain a CAN message with a 11-bit or 29-bit
* identifier.
*/
if ((rxLibMsg.MSGTYPE == PCAN_MESSAGE_STANDARD) ||
(rxLibMsg.MSGTYPE == PCAN_MESSAGE_EXTENDED))
{
/* Convert CAN mesage from PCAN-Basic format to the one of the CAN driver
* module.
*/
rxMsg.id = rxLibMsg.ID;
if (rxLibMsg.MSGTYPE == PCAN_MESSAGE_EXTENDED)
{
rxMsg.id |= CAN_MSG_EXT_ID_MASK;
}
rxMsg.dlc = rxLibMsg.LEN;
for (uint8_t idx = 0; idx < rxMsg.dlc; idx++)
{
rxMsg.data[idx] = rxLibMsg.DATA[idx];
}
/* Trigger message reception event(s). */
pEvents = pCanUsbEventsList;
for (uint32_t idx = 0; idx < pCanUsbEventsEntries; idx++)
{
if (pEvents != NULL)
{
if (pEvents->MsgRxed != NULL)
{
pEvents->MsgRxed(&rxMsg);
}
/* Move on to the next entry in the list. */
pEvents++;
}
}
}
}
break;
/* Termination event. */
default:
case WAIT_OBJECT_0 + 1: /*lint !e835 */
/* Stop thread. */
running = false;
break;
}
}
/* Exit thread. */
return 0;
} /*** end of PCanUsbReceptionThread ***/
/************************************************************************************//**
** \brief Loads the PCAN-Basic DLL and initializes the API function pointers.
**
****************************************************************************************/
static void PCanUsbLibLoadDll(void)
{
/* Start out by resetting the API function pointers. */
pCanUsbLibFuncInitializePtr = NULL;
pCanUsbLibFuncpUninitializePtr = NULL;
pCanUsbLibFuncGetStatusPtr = NULL;
pCanUsbLibFuncSetValuePtr = NULL;
pCanUsbLibFuncReadPtr = NULL;
pCanUsbLibFuncWritePtr = NULL;
pCanUsbLibFuncFilterMessagesPtr = NULL;
/* Attempt to load the library and obtain a handle to it. */
pCanUsbDllHandle = LoadLibrary("PCANBasic");
/* Assert libary handle. */
assert(pCanUsbDllHandle != NULL);
/* Only continue if the library was successfully loaded */
if (pCanUsbDllHandle != NULL) /*lint !e774 */
{
/* Set CAN_Initialize function pointer. */
pCanUsbLibFuncInitializePtr = (tPCanUsbLibFuncInitialize)GetProcAddress(pCanUsbDllHandle, "CAN_Initialize");
/* Set CAN_Uninitialize function pointer. */
pCanUsbLibFuncpUninitializePtr = (tPCanUsbLibFuncpUninitialize)GetProcAddress(pCanUsbDllHandle, "CAN_Uninitialize");
/* Set CAN_GetStatus function pointer. */
pCanUsbLibFuncGetStatusPtr = (tPCanUsbLibFuncGetStatus)GetProcAddress(pCanUsbDllHandle, "CAN_GetStatus");
/* Set CAN_SetValue function pointer. */
pCanUsbLibFuncSetValuePtr = (tPCanUsbLibFuncSetValue)GetProcAddress(pCanUsbDllHandle, "CAN_SetValue");
/* Set CAN_Read function pointer. */
pCanUsbLibFuncReadPtr = (tPCanUsbLibFuncRead)GetProcAddress(pCanUsbDllHandle, "CAN_Read");
/* Set CAN_Write function pointer. */
pCanUsbLibFuncWritePtr = (tPCanUsbLibFuncWrite)GetProcAddress(pCanUsbDllHandle, "CAN_Write");
/* Set CAN_FilterMessages function pointer. */
pCanUsbLibFuncFilterMessagesPtr = (tPCanUsbLibFuncFilterMessages)GetProcAddress(pCanUsbDllHandle, "CAN_FilterMessages");
}
} /*** end of PCanUsbLibLoadDll ***/
/************************************************************************************//**
** \brief Unloads the PCAN-Basic DLL and resets the API function pointers.
**
****************************************************************************************/
static void PCanUsbLibUnloadDll(void)
{
/* Reset the API function pointers. */
pCanUsbLibFuncInitializePtr = NULL;
pCanUsbLibFuncpUninitializePtr = NULL;
pCanUsbLibFuncGetStatusPtr = NULL;
pCanUsbLibFuncSetValuePtr = NULL;
pCanUsbLibFuncReadPtr = NULL;
pCanUsbLibFuncWritePtr = NULL;
pCanUsbLibFuncFilterMessagesPtr = NULL;
/* Unload the library and invalidate its handle. */
if (pCanUsbDllHandle != NULL)
{
(void)FreeLibrary(pCanUsbDllHandle);
pCanUsbDllHandle = NULL;
}
} /*** end of PCanUsbLibUnloadDll ***/
/************************************************************************************//**
** \brief Initializes a PCAN Channel.
** \param Channel The handle of a PCAN Channel.
** \param Btr0Btr1 The speed for the communication (BTR0BTR1 code).
** \param HwType The type of the Non-Plug-and-Play hardware and its operation mode.
** \param IOPort The I/O address for the parallel port of the Non-Plug-and-Play
** hardware.
** \param Interrupt The Interrupt number of the parallel port of the Non-Plug-
** and-Play hardware.
** \return The return value is a TPCANStatus code. PCAN_ERROR_OK is returned on
** success.
**
****************************************************************************************/
static TPCANStatus PCanUsbLibFuncInitialize(TPCANHandle Channel, TPCANBaudrate Btr0Btr1,
TPCANType HwType, DWORD IOPort,
WORD Interrupt)
{
/* set result to error. */
TPCANStatus result = PCAN_ERROR_INITIALIZE;
/* Check function pointer and library handle. */
assert(pCanUsbLibFuncInitializePtr != NULL);
assert(pCanUsbDllHandle != NULL);
/* Only continue with valid function pointer and library handle. */
if ((pCanUsbLibFuncInitializePtr != NULL) && (pCanUsbDllHandle != NULL)) /*lint !e774 */
{
/* Call library function. */
result = pCanUsbLibFuncInitializePtr(Channel, Btr0Btr1, HwType, IOPort, Interrupt);
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbLibFuncInitialize ***/
/************************************************************************************//**
** \brief Uninitializes a PCAN Channel.
** \param Channel The handle of a PCAN Channel.
** \return The return value is a TPCANStatus code. PCAN_ERROR_OK is returned on
** success.
**
****************************************************************************************/
static TPCANStatus PCanUsbLibFuncpUninitialize(TPCANHandle Channel)
{
/* set result to error. */
TPCANStatus result = PCAN_ERROR_INITIALIZE;
/* Check function pointer and library handle. */
assert(pCanUsbLibFuncpUninitializePtr != NULL);
assert(pCanUsbDllHandle != NULL);
/* Only continue with valid function pointer and library handle. */
if ((pCanUsbLibFuncpUninitializePtr != NULL) && (pCanUsbDllHandle != NULL)) /*lint !e774 */
{
/* Call library function. */
result = pCanUsbLibFuncpUninitializePtr(Channel);
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbLibFuncpUninitialize ***/
/************************************************************************************//**
** \brief Gets the current BUS status of a PCAN Channel.
** \param Channel The handle of a PCAN Channel.
** \return The return value is a TPCANStatus code. PCAN_ERROR_OK is returned on
** success.
**
****************************************************************************************/
static TPCANStatus PCanUsbLibFuncGetStatus(TPCANHandle Channel)
{
/* set result to error. */
TPCANStatus result = PCAN_ERROR_INITIALIZE;
/* Check function pointer and library handle. */
assert(pCanUsbLibFuncGetStatusPtr != NULL);
assert(pCanUsbDllHandle != NULL);
/* Only continue with valid function pointer and library handle. */
if ((pCanUsbLibFuncGetStatusPtr != NULL) && (pCanUsbDllHandle != NULL)) /*lint !e774 */
{
/* Call library function. */
result = pCanUsbLibFuncGetStatusPtr(Channel);
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbLibFuncGetStatus ***/
/************************************************************************************//**
** \brief Sets a configuration or information value within a PCAN Channel.
** \param Channel The handle of a PCAN Channel.
** \param Parameter The code of the value to be set .
** \param Buffer The buffer containing the value to be set.
** \param BufferLength The length in bytes of the given buffer.
** \return The return value is a TPCANStatus code. PCAN_ERROR_OK is returned on
** success.
**
****************************************************************************************/
static TPCANStatus PCanUsbLibFuncSetValue(TPCANHandle Channel, TPCANParameter Parameter,
void * Buffer, DWORD BufferLength)
{
/* set result to error. */
TPCANStatus result = PCAN_ERROR_INITIALIZE;
/* Check function pointer and library handle. */
assert(pCanUsbLibFuncSetValuePtr != NULL);
assert(pCanUsbDllHandle != NULL);
/* Only continue with valid function pointer and library handle. */
if ((pCanUsbLibFuncSetValuePtr != NULL) && (pCanUsbDllHandle != NULL)) /*lint !e774 */
{
/* Call library function. */
result = pCanUsbLibFuncSetValuePtr(Channel, Parameter, Buffer, BufferLength);
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbLibFuncSetValue ***/
/************************************************************************************//**
** \brief Reads a CAN message from the receive queue of a PCAN Channel.
** \param Channel The handle of a PCAN Channel.
** \param MessageBuffer A TPCANMsg buffer to store the CAN message.
** \param TimestampBuffer A TPCANTimestamp buffer to get the reception time of the
** message.
** \return The return value is a TPCANStatus code. PCAN_ERROR_OK is returned on
** success.
**
****************************************************************************************/
static TPCANStatus PCanUsbLibFuncRead(TPCANHandle Channel, TPCANMsg * MessageBuffer,
TPCANTimestamp * TimestampBuffer)
{
/* set result to error. */
TPCANStatus result = PCAN_ERROR_INITIALIZE;
/* Check function pointer and library handle. */
assert(pCanUsbLibFuncReadPtr != NULL);
assert(pCanUsbDllHandle != NULL);
/* Only continue with valid function pointer and library handle. */
if ((pCanUsbLibFuncReadPtr != NULL) && (pCanUsbDllHandle != NULL)) /*lint !e774 */
{
/* Call library function. */
result = pCanUsbLibFuncReadPtr(Channel, MessageBuffer, TimestampBuffer);
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbLibFuncRead ***/
/************************************************************************************//**
** \brief Transmits a CAN message.
** \param Channel The handle of a PCAN Channel.
** \param MessageBuffer A TPCANMsg buffer containing the CAN message to be sent.
** \return The return value is a TPCANStatus code. PCAN_ERROR_OK is returned on
** success.
**
****************************************************************************************/
static TPCANStatus PCanUsbLibFuncWrite(TPCANHandle Channel, TPCANMsg * MessageBuffer)
{
/* set result to error. */
TPCANStatus result = PCAN_ERROR_INITIALIZE;
/* Check function pointer and library handle. */
assert(pCanUsbLibFuncWritePtr != NULL);
assert(pCanUsbDllHandle != NULL);
/* Only continue with valid function pointer and library handle. */
if ((pCanUsbLibFuncWritePtr != NULL) && (pCanUsbDllHandle != NULL)) /*lint !e774 */
{
/* Call library function. */
result = pCanUsbLibFuncWritePtr(Channel, MessageBuffer);
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbLibFuncWrite ***/
/************************************************************************************//**
** \brief Configures the reception filter.
** \param Channel The handle of a PCAN Channel.
** \param FromID The lowest CAN ID wanted to be received.
** \param ToID The highest CAN ID wanted to be received.
** \param Mode The type of the filter being set.
** \return The return value is a TPCANStatus code. PCAN_ERROR_OK is returned on
** success.
**
****************************************************************************************/
static TPCANStatus PCanUsbLibFuncFilterMessages(TPCANHandle Channel, DWORD FromID,
DWORD ToID, TPCANMode Mode)
{
/* set result to error. */
TPCANStatus result = PCAN_ERROR_INITIALIZE;
/* Check function pointer and library handle. */
assert(pCanUsbLibFuncFilterMessagesPtr != NULL);
assert(pCanUsbDllHandle != NULL);
/* Only continue with valid function pointer and library handle. */
if ((pCanUsbLibFuncFilterMessagesPtr != NULL) && (pCanUsbDllHandle != NULL)) /*lint !e774 */
{
/* Call library function. */
result = pCanUsbLibFuncFilterMessagesPtr(Channel, FromID, ToID, Mode);
}
/* Give the result back to the caller. */
return result;
} /*** end of PCanUsbLibFuncFilterMessages ***/
/*********************************** end of pcanusb.c **********************************/

Binary file not shown.