a752c7ab
 elopes
add first test an...
|
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/*
* 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.
*/
/**
* @ingroup sys_can_dll
* @{
*
* @file
* @brief CAN memory allocation module
*
* @author Vincent Dupont <vincent@otakeys.com>
* @author Toon Stegen <toon.stegen@altran.com>
*/
#ifndef CAN_PKT_H
#define CAN_PKT_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdatomic.h>
#include "net/gnrc/pktbuf.h"
#include "can/common.h"
#include "can/can.h"
#include "msg.h"
#ifdef MODULE_CAN_MBOX
#include "mbox.h"
#endif
/**
* @brief A CAN packet
*
* A CAN packet is used to add stack-related data around a CAN frame
*/
typedef struct {
can_reg_entry_t entry; /**< entry containing ifnum and upper layer info */
atomic_uint ref_count; /**< Reference counter (for rx frames) */
int handle; /**< handle (for tx frames */
struct can_frame frame; /**< CAN Frame */
gnrc_pktsnip_t *snip; /**< Pointer to the allocated snip */
} can_pkt_t;
/**
* @brief Initialize the CAN packet module
*
* This must be called by the DLL to initialize the module
*/
void can_pkt_init(void);
/**
* @brief Allocate a CAN packet to transmit
*
* This function allocates a CAN packet and associates it to the @p ifnum and @p tx_pid.
* The provided @p frame is copied into the CAN packet and a unique handle is set.
*
* @param[in] ifnum the interface number
* @param[in] frame the frame to copy
* @param[in] tx_pid the pid of the sender's device thread
*
* @return an allocated CAN packet, NULL if an error occured
*/
can_pkt_t *can_pkt_alloc_tx(int ifnum, const struct can_frame *frame, kernel_pid_t tx_pid);
/**
* @brief Allocate an incoming CAN packet
*
* @param[in] ifnum the interface number
* @param[in] frame the received frame
*
* @return an allocated CAN packet, NULL if an error occured
*/
can_pkt_t *can_pkt_alloc_rx(int ifnum, const struct can_frame *frame);
#if defined(MODULE_CAN_MBOX) || defined(DOXYGEN)
/**
* @brief Allocate a CAN packet for a mbox to transmit
*
* This function allocates a CAN packet and associate it to the @p ifnum and @p mbox.
* The provided @p frame is copied into the CAN packet and a unique handle is set.
*
* @param[in] ifnum the interface number
* @param[in] frame the frame to copy
* @param[in] mbox the pointer to the sender's mbox
*
* @return an allocated CAN packet, NULL if an error occured
*/
can_pkt_t *can_pkt_alloc_mbox_tx(int ifnum, const struct can_frame *frame, mbox_t *mbox);
#endif
/**
* @brief Free a CAN packet
*
* @param[in] pkt the packet to free, it must be a pointer returned
* by @ref can_pkt_alloc_tx or @ref can_pkt_alloc_rx
*/
void can_pkt_free(can_pkt_t *pkt);
/**
* @brief Allocate a @p can_rx_data_t and initialize it with gieven parameters
*
* This is used to allocate a return value to the upper layer
*
* @param[in] data data which will be returned
* @param[in] len length of @p data
* @param[in] arg optional argument for the upper layer
*
* @return a @p can_rx_data_t pointer, NULL if out of memory
*/
can_rx_data_t *can_pkt_alloc_rx_data(void *data, size_t len, void *arg);
/**
* @brief Free rx data previously allocated by can_pkt_alloc_rx_data()
*
* @param[in] data the pointer to free
*/
void can_pkt_free_rx_data(can_rx_data_t *data);
/**
* @brief Allocate @p size bytes and return the pointer
*
* This function has been copied from gnrc_pktbuf_static
*
* @param[in] size the number of bytes to allocate
*
* @return the pointer to thje allocated data, NULL if out of memory
*/
void *can_pkt_buf_alloc(size_t size);
/**
* @brief Free the data allocated by can_pkt_buf_alloc()
*
* @param[in] data the pointer to free
* @param[in] size the size of the data to free
*/
void can_pkt_buf_free(void *data, size_t size);
#ifdef __cplusplus
}
#endif
#endif /* CAN_PKT_H */
/** @} */
|