summaryrefslogtreecommitdiffstats
path: root/src/isotp/isotp.h
blob: 089ecbc0060c3f81517227969cd6698ea236ccd7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
#ifndef __ISOTP_H__
#define __ISOTP_H__

#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

const uint16_t MAX_ISO_TP_MESSAGE_SIZE;
const uint16_t MAX_CAN_FRAME_SIZE;
const uint8_t ISO_TP_DEFAULT_RESPONSE_TIMEOUT;
const bool ISO_TP_DEFAULT_FRAME_PADDING_STATUS;

typedef void (*LogShim)(const char* message);
typedef bool (*SendCanMessageShim)(const uint16_t arbitration_id, const uint8_t* data,
            const uint8_t size);
typedef bool (*SetTimerShim)(uint16_t time_ms, void (*callback));

typedef void (*IsoTpMessageReceivedHandler)(const uint16_t arbitration_id,
        const uint8_t* payload, const uint16_t size);
typedef void (*IsoTpMessageSentHandler)(const bool success,
        const uint16_t arbitration_id, const uint8_t* payload,
        const uint16_t size);
typedef void (*IsoTpCanFrameSentHandler)(const uint16_t arbitration_id,
        const uint8_t* payload, const uint8_t size);

// TODO this is really necessary and it would leak this library into the user's
// code
// typedef struct {
    // const uint16_t arbitration_id;
    // const uint8_t* payload;
    // const uint16_t size;
// } IsoTpMessage;

typedef struct {
    LogShim log;
    SendCanMessageShim send_can_message;
    SetTimerShim set_timer;
} IsoTpShims;

typedef struct {
    IsoTpShims* shims;
    uint16_t arbitration_id;
    IsoTpMessageReceivedHandler message_received_callback;
    IsoTpMessageSentHandler message_sent_callback;
    IsoTpCanFrameSentHandler can_frame_sent_callback;

    // Private
    uint16_t timeout_ms;
    bool frame_padding;
    uint8_t* receive_buffer;
    uint16_t received_buffer_size;
    uint16_t incoming_message_size;
    bool sending;
    // TODO timer callback
} IsoTpHandler;

typedef enum {
    PCI_SINGLE = 0x0,
    PCI_FIRST_FRAME = 0x1,
    PCI_CONSECUTIVE_FRAME = 0x2,
    PCI_FLOW_CONTROL_FRAME = 0x3
} IsoTpProtocolControlInformation;

typedef enum {
    PCI_FLOW_STATUS_CONTINUE = 0x0,
    PCI_FLOW_STATUS_WAIT = 0x1,
    PCI_FLOW_STATUS_OVERFLOW = 0x2
} IsoTpFlowStatus;

IsoTpShims isotp_init_shims(LogShim log,
        SendCanMessageShim send_can_message,
        SetTimerShim set_timer);

IsoTpHandler isotp_init(IsoTpShims* shims,
        uint16_t arbitration_id,
        IsoTpMessageReceivedHandler message_received_callback,
        IsoTpMessageSentHandler message_sent_callback,
        IsoTpCanFrameSentHandler can_frame_sent_callback);

/* Public: Change the timeout for waiting on an ISO-TP response frame.
 *
 * If this function is not used, the conventional 100ms is used by default.
 *
 * handler - the ISO-TP handler to modify.
 * timeout - the new timeout in milliseconds.
 */
void isotp_set_timeout(IsoTpHandler* handler, uint16_t timeout_ms);

// TODO we have to make sure to copy the payload internall if it's more than 1
// frame, the soure could go out of scope
bool isotp_send(const uint8_t* payload, uint16_t payload_size);

void isotp_receive_can_frame(IsoTpHandler* handler,
        const uint16_t arbitration_id, const uint8_t* data,
        const uint8_t length);

void isotp_destroy(IsoTpHandler* handler);

void log_isotp_message(const uint16_t arbitration_id, const uint8_t* payload,
        const uint16_t size);


#ifdef __cplusplus
}
#endif

#endif // __ISOTP_H__