CanSetting.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Can settings
 *
 *  Use the function GetCanSetting() to get a handle to pass on to the other functions.
 *  Use the method CanSetting_release(CANSETTINGHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include cansetting_example.cpp
 *
 ************************************************/
#ifndef CC_CAN_SETTING_H
#define CC_CAN_SETTING_H
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *CANSETTINGHANDLE;
 
EXTERN_C
CCAUXDLL_API
CANSETTINGHANDLE
CCAUXDLL_CALLING_CONV
GetCanSetting(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV CanSetting_release(CANSETTINGHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV CanSetting_getBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t *baudrate);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV CanSetting_getFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType *frameType);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV CanSetting_setBaudrate(CANSETTINGHANDLE, uint8_t net, uint16_t baudrate);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV CanSetting_setFrameType(CANSETTINGHANDLE, uint8_t net, CanFrameType frameType);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV CanSetting_getFlexibleDataBaudrates(CANSETTINGHANDLE, uint8_t net, uint16_t *baudrateNominal,
                                                               uint16_t *baudrateData);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV CanSetting_setFlexibleDataBaudrates(CANSETTINGHANDLE, uint8_t net, uint16_t baudrateNominal,
                                                               uint16_t baudrateData);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_CAN_SETTING_H */