4 * @brief global data used from different modules in frescan
15 * In order to simplify we have a single module, frescan_data, to store the
16 * main internal structures and global data of the FRESCAN protocol.
20 * See MaRTE OS license
24 #ifndef _MARTE_FRESCAN_DATA_H_
25 #define _MARTE_FRESCAN_DATA_H_
27 #include <stdint.h> // uint32_t
28 #include <semaphore.h> // sem_t
29 #include <time.h> // struct timespec, timer_t
30 #include "fosa_threads_and_signals.h" // fosa_thread_id_t
32 #include <misc/linux_list.h> // struct list_head
33 #include <misc/freelist.h> // freelist_t
35 #include "frescan.h" // frescan_node_t, _prio_t, _budget_t
36 #include "frescan_config.h" // FRESCAN_MLOCK_T, FRESCAN_MX_XXX
37 #include "frescan_packets.h" // frescan_packet_t
38 #include "frescan_servers_replenishments.h" // frescan_repl_op_t
41 * frescan_repl_op_t - a replenishment operation
43 * @when: when the replenishment operation is programmed at
44 * @amount: number of frames to add to the current_budget
45 * @repl_list: to chain the replenishments for a certain sporadic server
46 * @pool_pos: to know how to free it from the replenishment pool
51 frescan_budget_t amount;
52 struct list_head repl_list;
57 * frescan_server_params_t - server parameters
59 * @budget: the budget in CAN 8-byte frames
60 * @period: the replenishment period for the server
61 * @prio: the priority for the server TODO: this should be a return value
65 frescan_budget_t budget;
66 struct timespec period;
67 } frescan_budget_period_t;
70 frescan_budget_period_t values;
72 } frescan_server_params_t;
75 * frescan_server_data_t - server data
77 * @params: the fixed parameters (budget, period and priority)
78 * @current_budget: the current available capacity
79 * @current_priority: the current priority (0=background)
80 * @repl_list: the list of pending replenishment operations
81 * @repl_timer: the timer for the replenishments associated to this server
82 * NOTE: we could use a single timer for all but for now this is simpler
83 * @packet_list: the packets enqueued on this server
87 frescan_server_params_t params;
88 frescan_network_t net;
90 frescan_budget_t current_budget;
91 frescan_prio_t current_priority;
92 frescan_budget_t pending_packets;
93 frescan_repl_op_t replenishments;
95 frescan_packet_t packet_list;
96 struct list_head servers_list;
97 } frescan_server_data_t;
100 * the_servers_pool - pool of servers structure
103 extern frescan_server_data_t the_servers_pool[FRESCAN_MX_NETWORKS][FRESCAN_MX_IDS];
104 extern freelist_t the_servers_pool_freelist[FRESCAN_MX_NETWORKS];
105 extern frescan_server_data_t the_active_servers[FRESCAN_MX_NETWORKS];
112 frescan_budget_period_t min_values;
113 frescan_budget_period_t max_values;
115 } frescan_contract_t;
118 * frescan_prio_queue_t - priority queue
120 * FRESCAN priority queues are implemented as an array of one 'fifo_queue' for
121 * each priority. Where the 'fifo_queues' are implemented using the
122 * 'struct list_head fifo_list;' field of each packet structure (Linux lists).
124 * So far mutual exclusion is achieved by disabling interrupts and
125 * synchronization is done using a semaphore. This is because the queues
126 * are accesed concurrently from user threads and the IRQ handler.
128 * @net: the network this priority queue belongs to (mainly for locking)
129 * @fifo_queues: an array of packets for each priority where each packet
130 * is just the head of a fifo_list. The array is allocated
131 * from the heap, using malloc, at initialization with range
133 * @max_prio: defines the number of priorities as (0 .. max_prio - 1)
134 * @sem: semaphore used for synchronization
138 frescan_network_t net;
139 frescan_packet_t *fifo_queues;
142 } frescan_prio_queue_t;
145 * frescan_queues_t - the set of FRESCAN queues for each instance of a protocol
147 * @tx_fp_queue: priority queue for the fixed priority packets
148 * @rx_channel_queues: a priority queue for each receiving channel
150 * TODO: add here the sporadic server queues...
154 frescan_prio_queue_t *tx_fp_queue;
155 frescan_prio_queue_t **rx_channel_queues;
156 uint32_t num_rx_channels;
160 * frescan_network_data_t - data for each network instance
162 * @local_node: the local node id for that network. The implementation does not
163 * support several interfaces for the same network.
164 * @fd: file descriptor associated to /dev/canXX
165 * @repl_thread_id: replenishment thread id
166 * @manager_thread_id: manager thread id
167 * @acceptor_thread_id: acceptor thread id
168 * @neg_messages_ss_id: sporadic server for negotiation messages
169 * @queues: the queues of this network instance
170 * @last_packet: pointer to the last packet from which a frame was inserted
171 * in the chip and its transmission is not complete.
172 * @last_packet_prio: prio of the packet in the buffer
173 * @id_queues: queues to store received packets while the whole message is
174 * not complete (fragmentation). (id = 0 .. FRESCAN_MX_IDS - 1)
175 * @id_fp_queues: the same as id_queues but for fp messages, which have
176 * id=FRESCAN_MX_IDS and are distinguised through their
179 * the implementation can handle several FRESCAN networks at the same time
180 * in the same node, so we need a place to store its internal data. The data
181 * is allocated as an array where the index is the MINOR number (which also
182 * identifies the /dev/canx device for that network)
186 FRESCAN_MLOCK_T lock;
187 frescan_node_t local_node;
189 fosa_thread_id_t repl_thread_id;
190 fosa_thread_id_t manager_thread_id;
191 fosa_thread_id_t acceptor_thread_id;
192 frescan_ss_t neg_messages_ss_id;
193 frescan_queues_t queues;
194 frescan_packet_t *last_packet;
195 frescan_prio_t last_packet_prio;
196 frescan_packet_t *id_queues[FRESCAN_MX_IDS]; // TODO: alloc at init
197 frescan_packet_t *id_fp_queues[FRESCAN_MX_PRIOS]; // TODO: alloc at init
198 } frescan_network_data_t;
200 extern frescan_network_data_t the_networks[FRESCAN_MX_NETWORKS];
203 * frescan_data_init() - init the data global variables
207 extern int frescan_data_init(int fd, frescan_init_params_t *params);
211 #endif // _MARTE_FRESCAN_DATA_H_