Xenomai  3.0-rc7
rtcfg_event.h
1 /***
2  *
3  * include/rtcfg/rtcfg_event.h
4  *
5  * Real-Time Configuration Distribution Protocol
6  *
7  * Copyright (C) 2003-2005 Jan Kiszka <jan.kiszka@web.de>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  *
23  */
24 
25 #ifndef __RTCFG_EVENT_H_
26 #define __RTCFG_EVENT_H_
27 
28 #include <linux/if_ether.h>
29 #include <linux/netdevice.h>
30 
31 #include <rtcfg_chrdev.h>
32 #include <rtdev.h>
33 #include <rtnet_internal.h>
34 #include <rtnet_rtpc.h>
35 
36 
37 #define FLAG_TIMER_STARTED 0x00010000
38 #define FLAG_TIMER_SHUTDOWN 0x00020000
39 
40 
41 typedef enum {
42  RTCFG_MAIN_OFF,
43  RTCFG_MAIN_SERVER_RUNNING,
44  RTCFG_MAIN_CLIENT_0,
45  RTCFG_MAIN_CLIENT_1,
46  RTCFG_MAIN_CLIENT_ANNOUNCED,
47  RTCFG_MAIN_CLIENT_ALL_KNOWN,
48  RTCFG_MAIN_CLIENT_ALL_FRAMES,
49  RTCFG_MAIN_CLIENT_2,
50  RTCFG_MAIN_CLIENT_READY
51 } RTCFG_MAIN_STATE;
52 
53 struct rtcfg_station {
54  u8 mac_addr[ETH_ALEN]; /* Ethernet-specific! */
55  u8 flags;
56 };
57 
58 struct rtcfg_device {
59  RTCFG_MAIN_STATE state;
60  u32 other_stations;
61  u32 stations_found;
62  u32 stations_ready;
63  rtdm_mutex_t dev_mutex;
64  struct list_head event_calls;
65  rtdm_lock_t event_calls_lock;
66  rtdm_task_t timer_task;
67  unsigned int flags;
68  unsigned int burstrate;
69 #ifdef CONFIG_XENO_OPT_VFILE
70  struct xnvfile_directory proc_entry;
71  struct xnvfile_regular proc_state_vfile;
72  struct xnvfile_regular proc_stations_vfile;
73 #endif
74 
75  union {
76  struct {
77  unsigned int addr_type;
78  union {
79 #if IS_ENABLED(CONFIG_XENO_DRIVERS_NET_RTIPV4)
80  u32 ip_addr;
81 #endif
82  } srv_addr;
83  u8 srv_mac_addr[MAX_ADDR_LEN];
84  u8 *stage2_buffer;
85  u32 cfg_len;
86  u32 cfg_offs;
87  unsigned int packet_counter;
88  u32 chain_len;
89  struct rtskb *stage2_chain;
90  u32 max_stations;
91  struct rtcfg_station *station_addr_list;
92  } clt;
93 
94  struct {
95  u32 clients_configured;
96  struct list_head conn_list;
97  u16 heartbeat;
98  u64 heartbeat_timeout;
99  } srv;
100  } spec;
101 };
102 
103 
104 extern struct rtcfg_device device[MAX_RT_DEVICES];
105 extern const char *rtcfg_event[];
106 extern const char *rtcfg_main_state[];
107 
108 
109 int rtcfg_do_main_event(int ifindex, RTCFG_EVENT event_id, void* event_data);
110 void rtcfg_next_main_state(int ifindex, RTCFG_MAIN_STATE state);
111 
112 void rtcfg_queue_blocking_call(int ifindex, struct rt_proc_call *call);
113 struct rt_proc_call *rtcfg_dequeue_blocking_call(int ifindex);
114 void rtcfg_complete_cmd(int ifindex, RTCFG_EVENT event_id, int result);
115 void rtcfg_reset_device(int ifindex);
116 
117 void rtcfg_init_state_machines(void);
118 void rtcfg_cleanup_state_machines(void);
119 
120 #endif /* __RTCFG_EVENT_H_ */
ipipe_spinlock_t rtdm_lock_t
Lock variable.
Definition: driver.h:528