drivers/net/can/usb/peak_usb/pcan_usb_core.h

   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
  29 #define PCAN_USB_DRIVER_NAME            "peak_usb"
  30
  31 /* number of urbs that are submitted for rx/tx per channel */
  32 #define PCAN_USB_MAX_RX_URBS            4
  33 #define PCAN_USB_MAX_TX_URBS            10
  34
  35 /* usb adapters maximum channels per usb interface */
  36 #define PCAN_USB_MAX_CHANNEL            2
  37
  38 /* maximum length of the usb commands sent to/received from  the devices */
  39 #define PCAN_USB_MAX_CMD_LEN            32
  40
  41 struct peak_usb_device;
  42
  43 /* PEAK-System USB adapter descriptor */
  44 struct peak_usb_adapter {
  45         char *name;
  46         u32 device_id;
  47         u32 ctrlmode_supported;
  48         struct can_clock clock;
  49         const struct can_bittiming_const bittiming_const;
  50         const struct can_bittiming_const data_bittiming_const;
  51         unsigned int ctrl_count;
  52
  53         int (*intf_probe)(struct usb_interface *intf);
  54
  55         int (*dev_init)(struct peak_usb_device *dev);
  56         void (*dev_exit)(struct peak_usb_device *dev);
  57         void (*dev_free)(struct peak_usb_device *dev);
  58         int (*dev_open)(struct peak_usb_device *dev);
  59         int (*dev_close)(struct peak_usb_device *dev);
  60         int (*dev_set_bittiming)(struct peak_usb_device *dev,
  61                                         struct can_bittiming *bt);
  62         int (*dev_set_data_bittiming)(struct peak_usb_device *dev,
  63                                       struct can_bittiming *bt);
  64         int (*dev_set_bus)(struct peak_usb_device *dev, u8 onoff);
  65         int (*dev_get_device_id)(struct peak_usb_device *dev, u32 *device_id);
  66         int (*dev_decode_buf)(struct peak_usb_device *dev, struct urb *urb);
  67         int (*dev_encode_msg)(struct peak_usb_device *dev, struct sk_buff *skb,
  68                                         u8 *obuf, size_t *size);
  69         int (*dev_start)(struct peak_usb_device *dev);
  70         int (*dev_stop)(struct peak_usb_device *dev);
  71         int (*dev_restart_async)(struct peak_usb_device *dev, struct urb *urb,
  72                                         u8 *buf);
  73         int (*do_get_berr_counter)(const struct net_device *netdev,
  74                                    struct can_berr_counter *bec);
  75         u8 ep_msg_in;
  76         u8 ep_msg_out[PCAN_USB_MAX_CHANNEL];
  77         u8 ts_used_bits;
  78         u32 ts_period;
  79         u8 us_per_ts_shift;
  80         u32 us_per_ts_scale;
  81
  82         int rx_buffer_size;
  83         int tx_buffer_size;
  84         int sizeof_dev_private;
  85 };
  86
  87 extern const struct peak_usb_adapter pcan_usb;
  88 extern const struct peak_usb_adapter pcan_usb_pro;
  89
  90 struct peak_time_ref {
  91         struct timeval tv_host_0, tv_host;
  92         u32 ts_dev_1, ts_dev_2;
  93         u64 ts_total;
  94         u32 tick_count;
  95         const struct peak_usb_adapter *adapter;
  96 };
  97
  98 struct peak_tx_urb_context {
  99         struct peak_usb_device *dev;
 100         u32 echo_index;
 101         u8 dlc;
 102         struct urb *urb;
 103 };
 104
 105 #define PCAN_USB_STATE_CONNECTED        0x00000001
 106 #define PCAN_USB_STATE_STARTED          0x00000002
 107
 108 /* PEAK-System USB device */
 109 struct peak_usb_device {
 110         struct can_priv can;
 111         const struct peak_usb_adapter *adapter;
 112         unsigned int ctrl_idx;
 113         u32 state;
 114
 115         struct sk_buff *echo_skb[PCAN_USB_MAX_TX_URBS];
 116
 117         struct usb_device *udev;
 118         struct net_device *netdev;
 119
 120         atomic_t active_tx_urbs;
 121         struct usb_anchor tx_submitted;
 122         struct peak_tx_urb_context tx_contexts[PCAN_USB_MAX_TX_URBS];
 123
 124         u8 *cmd_buf;
 125         struct usb_anchor rx_submitted;
 126
 127         u32 device_number;
 128         u8 device_rev;
 129
 130         u8 ep_msg_in;
 131         u8 ep_msg_out;
 132
 133         u16 bus_load;
 134
 135         struct peak_usb_device *prev_siblings;
 136         struct peak_usb_device *next_siblings;
 137 };
 138
 139 void pcan_dump_mem(char *prompt, void *p, int l);
 140
 141 /* common timestamp management */
 142 void peak_usb_init_time_ref(struct peak_time_ref *time_ref,
 143                             const struct peak_usb_adapter *adapter);
 144 void peak_usb_update_ts_now(struct peak_time_ref *time_ref, u32 ts_now);
 145 void peak_usb_set_ts_now(struct peak_time_ref *time_ref, u32 ts_now);
 146 void peak_usb_get_ts_tv(struct peak_time_ref *time_ref, u32 ts,
 147                         struct timeval *tv);
 148
 149 void peak_usb_async_complete(struct urb *urb);
 150 void peak_usb_restart_complete(struct peak_usb_device *dev);
 151 #endif