• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * CAN driver for PEAK System USB adapters
3  * Derived from the PCAN project file driver/src/pcan_usb_core.c
4  *
5  * Copyright (C) 2003-2010 PEAK System-Technik GmbH
6  * Copyright (C) 2010-2012 Stephane Grosjean <s.grosjean@peak-system.com>
7  *
8  * Many thanks to Klaus Hitschler <klaus.hitschler@gmx.de>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU General Public License as published
12  * by the Free Software Foundation; version 2 of the License.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  */
19 #ifndef PCAN_USB_CORE_H
20 #define PCAN_USB_CORE_H
21 
22 /* PEAK-System vendor id. */
23 #define PCAN_USB_VENDOR_ID		0x0c72
24 
25 /* supported device ids. */
26 #define PCAN_USB_PRODUCT_ID		0x000c
27 #define PCAN_USBPRO_PRODUCT_ID		0x000d
28 #define PCAN_USBPROFD_PRODUCT_ID	0x0011
29 #define PCAN_USBFD_PRODUCT_ID		0x0012
30 #define PCAN_USBX6_PRODUCT_ID		0x0014
31 
32 #define PCAN_USB_DRIVER_NAME		"peak_usb"
33 
34 /* number of urbs that are submitted for rx/tx per channel */
35 #define PCAN_USB_MAX_RX_URBS		4
36 #define PCAN_USB_MAX_TX_URBS		10
37 
38 /* usb adapters maximum channels per usb interface */
39 #define PCAN_USB_MAX_CHANNEL		2
40 
41 /* maximum length of the usb commands sent to/received from  the devices */
42 #define PCAN_USB_MAX_CMD_LEN		32
43 
44 struct peak_usb_device;
45 
46 /* PEAK-System USB adapter descriptor */
47 struct peak_usb_adapter {
48 	char *name;
49 	u32 device_id;
50 	u32 ctrlmode_supported;
51 	struct can_clock clock;
52 	const struct can_bittiming_const * const bittiming_const;
53 	const struct can_bittiming_const * const data_bittiming_const;
54 	unsigned int ctrl_count;
55 
56 	int (*intf_probe)(struct usb_interface *intf);
57 
58 	int (*dev_init)(struct peak_usb_device *dev);
59 	void (*dev_exit)(struct peak_usb_device *dev);
60 	void (*dev_free)(struct peak_usb_device *dev);
61 	int (*dev_open)(struct peak_usb_device *dev);
62 	int (*dev_close)(struct peak_usb_device *dev);
63 	int (*dev_set_bittiming)(struct peak_usb_device *dev,
64 					struct can_bittiming *bt);
65 	int (*dev_set_data_bittiming)(struct peak_usb_device *dev,
66 				      struct can_bittiming *bt);
67 	int (*dev_set_bus)(struct peak_usb_device *dev, u8 onoff);
68 	int (*dev_get_device_id)(struct peak_usb_device *dev, u32 *device_id);
69 	int (*dev_decode_buf)(struct peak_usb_device *dev, struct urb *urb);
70 	int (*dev_encode_msg)(struct peak_usb_device *dev, struct sk_buff *skb,
71 					u8 *obuf, size_t *size);
72 	int (*dev_start)(struct peak_usb_device *dev);
73 	int (*dev_stop)(struct peak_usb_device *dev);
74 	int (*dev_restart_async)(struct peak_usb_device *dev, struct urb *urb,
75 					u8 *buf);
76 	int (*do_get_berr_counter)(const struct net_device *netdev,
77 				   struct can_berr_counter *bec);
78 	u8 ep_msg_in;
79 	u8 ep_msg_out[PCAN_USB_MAX_CHANNEL];
80 	u8 ts_used_bits;
81 	u32 ts_period;
82 	u8 us_per_ts_shift;
83 	u32 us_per_ts_scale;
84 
85 	int rx_buffer_size;
86 	int tx_buffer_size;
87 	int sizeof_dev_private;
88 };
89 
90 extern const struct peak_usb_adapter pcan_usb;
91 extern const struct peak_usb_adapter pcan_usb_pro;
92 extern const struct peak_usb_adapter pcan_usb_fd;
93 extern const struct peak_usb_adapter pcan_usb_pro_fd;
94 extern const struct peak_usb_adapter pcan_usb_x6;
95 
96 struct peak_time_ref {
97 	struct timeval tv_host_0, tv_host;
98 	u32 ts_dev_1, ts_dev_2;
99 	u64 ts_total;
100 	u32 tick_count;
101 	const struct peak_usb_adapter *adapter;
102 };
103 
104 struct peak_tx_urb_context {
105 	struct peak_usb_device *dev;
106 	u32 echo_index;
107 	u8 data_len;
108 	struct urb *urb;
109 };
110 
111 #define PCAN_USB_STATE_CONNECTED	0x00000001
112 #define PCAN_USB_STATE_STARTED		0x00000002
113 
114 /* PEAK-System USB device */
115 struct peak_usb_device {
116 	struct can_priv can;
117 	const struct peak_usb_adapter *adapter;
118 	unsigned int ctrl_idx;
119 	u32 state;
120 
121 	struct sk_buff *echo_skb[PCAN_USB_MAX_TX_URBS];
122 
123 	struct usb_device *udev;
124 	struct net_device *netdev;
125 
126 	atomic_t active_tx_urbs;
127 	struct usb_anchor tx_submitted;
128 	struct peak_tx_urb_context tx_contexts[PCAN_USB_MAX_TX_URBS];
129 
130 	u8 *cmd_buf;
131 	struct usb_anchor rx_submitted;
132 
133 	u32 device_number;
134 	u8 device_rev;
135 
136 	u8 ep_msg_in;
137 	u8 ep_msg_out;
138 
139 	u16 bus_load;
140 
141 	struct peak_usb_device *prev_siblings;
142 	struct peak_usb_device *next_siblings;
143 };
144 
145 void pcan_dump_mem(char *prompt, void *p, int l);
146 
147 /* common timestamp management */
148 void peak_usb_init_time_ref(struct peak_time_ref *time_ref,
149 			    const struct peak_usb_adapter *adapter);
150 void peak_usb_update_ts_now(struct peak_time_ref *time_ref, u32 ts_now);
151 void peak_usb_set_ts_now(struct peak_time_ref *time_ref, u32 ts_now);
152 void peak_usb_get_ts_tv(struct peak_time_ref *time_ref, u32 ts,
153 			struct timeval *tv);
154 int peak_usb_netif_rx(struct sk_buff *skb,
155 		      struct peak_time_ref *time_ref, u32 ts_low, u32 ts_high);
156 void peak_usb_async_complete(struct urb *urb);
157 void peak_usb_restart_complete(struct peak_usb_device *dev);
158 
159 #endif
160