isotp.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 OTA keys S.A.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "compiler_hints.h"
#include "can/can.h"
#include "can/isotp.h"
#include "mbox.h"
 
#if defined(MODULE_CONN_CAN_ISOTP_MULTI) || defined(DOXYGEN)
#include "mutex.h"
 
#ifndef CONN_CAN_ISOTP_MBOX_SIZE
#define CONN_CAN_ISOTP_MBOX_SIZE (16)
#endif

typedef struct conn_can_isotp_master conn_can_isotp_t;

typedef struct conn_can_isotp_slave {
    struct conn_can_isotp_slave *next;     
    struct conn_can_isotp_master *master;  
    struct isotp isotp;                    
    int ifnum;                             
    int bound;                             
    can_rx_data_t *rx;                     
} conn_can_isotp_slave_t;

struct conn_can_isotp_master {
    /* slave fields */
    struct conn_can_isotp_slave *next;     
    struct conn_can_isotp_master *master;  
    struct isotp isotp;                    
    int ifnum;                             
    int bound;                             
    can_rx_data_t *rx;                     
    /* slave fields end */
    mutex_t lock;                          
    mbox_t mbox;                           
    msg_t mbox_queue[CONN_CAN_ISOTP_MBOX_SIZE];
};

static inline void conn_can_isotp_init_slave(conn_can_isotp_t *master,
                                             conn_can_isotp_slave_t *slave)
{
    slave->next = NULL;
    slave->master = master;
    slave->rx = NULL;
}
#else
 
#ifndef CONN_CAN_ISOTP_MBOX_SIZE
#define CONN_CAN_ISOTP_MBOX_SIZE (16)
#endif

typedef struct conn_can_isotp {
    struct isotp isotp; 
    int ifnum;          
    int bound;          
    mbox_t mbox;        
    msg_t mbox_queue[CONN_CAN_ISOTP_MBOX_SIZE];
} conn_can_isotp_t;
#endif /* MODULE_CONN_CAN_ISOTP_MULTI */

int conn_can_isotp_create(conn_can_isotp_t *conn, struct isotp_options *options, int ifnum);

int conn_can_isotp_bind(conn_can_isotp_t *conn, struct isotp_fc_options *fc_options);

int conn_can_isotp_close(conn_can_isotp_t *conn);

ACCESS(write_only, 2, 3)
int conn_can_isotp_recv(conn_can_isotp_t *conn, void *buf, size_t size, uint32_t timeout);

ACCESS(read_only, 2, 3)
int conn_can_isotp_send(conn_can_isotp_t *conn, const void *buf, size_t size, int flags);
 
#if defined(MODULE_CONN_CAN_ISOTP_MULTI) || defined(DOXYGEN)
int conn_can_isotp_select(conn_can_isotp_slave_t **conn, conn_can_isotp_t *master,
                          uint32_t timeout);
#endif
 
#ifdef __cplusplus
}
#endif