device.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 OTA keys S.A.
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#ifndef CAN_DEVICE_H
#define CAN_DEVICE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "can/candev.h"
#include "sched.h"
 
#ifdef MODULE_CAN_PM
#include "ztimer.h"
#endif
#ifdef MODULE_CAN_TRX
#include "can/can_trx.h"
#endif
 
#ifndef CAN_MAX_RATE_ERROR
#define CAN_MAX_RATE_ERROR  (50) /* 5 % */
#endif
 
#ifndef CAN_DLL_NUMOF
#define CAN_DLL_NUMOF       (1)
#endif
 
typedef struct candev_params {
    const char *name;                
#if defined(MODULE_CAN_TRX) || defined(DOXYGEN)
    can_trx_t *trx;                  
#endif
#if defined(MODULE_CAN_PM) || defined(DOXYGEN)
    uint32_t rx_inactivity_timeout;  
    uint32_t tx_wakeup_timeout;      
#endif
} candev_params_t;
 
typedef struct candev_dev {
    candev_t *dev;    
    int ifnum;        
    kernel_pid_t pid; 
    const char *name; 
#if defined(MODULE_CAN_TRX) || defined(DOXYGEN)
    can_trx_t *trx;   
#endif
#if defined(MODULE_CAN_PM) || defined(DOXYGEN)
    uint32_t rx_inactivity_timeout; 
    uint32_t tx_wakeup_timeout;     
    uint32_t last_pm_update;   
    uint32_t last_pm_value;    
    ztimer_t pm_timer;         
#endif
} candev_dev_t;
 
kernel_pid_t can_device_init(char *stack, int stacksize, char priority,
                             const char *name, candev_dev_t *params);
 
int can_device_calc_bittiming(uint32_t clock, const struct can_bittiming_const *timing_const,
                              struct can_bittiming *bittiming);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CAN_DEVICE_H */