include/net/caif/caif_hsi.h

   1 /*
   2  * Copyright (C) ST-Ericsson AB 2010
   3  * Contact: Sjur Brendeland / sjur.brandeland@stericsson.com
   4  * Author:  Daniel Martensson / daniel.martensson@stericsson.com
   5  *          Dmitry.Tarnyagin  / dmitry.tarnyagin@stericsson.com
   6  * License terms: GNU General Public License (GPL) version 2
   7  */
   8
   9 #ifndef CAIF_HSI_H_
  10 #define CAIF_HSI_H_
  11
  12 #include <net/caif/caif_layer.h>
  13 #include <net/caif/caif_device.h>
  14 #include <linux/atomic.h>
  15
  16 /*
  17  * Maximum number of CAIF frames that can reside in the same HSI frame.
  18  */
  19 #define CFHSI_MAX_PKTS 15
  20
  21 /*
  22  * Maximum number of bytes used for the frame that can be embedded in the
  23  * HSI descriptor.
  24  */
  25 #define CFHSI_MAX_EMB_FRM_SZ 96
  26
  27 /*
  28  * Decides if HSI buffers should be prefilled with 0xFF pattern for easier
  29  * debugging. Both TX and RX buffers will be filled before the transfer.
  30  */
  31 #define CFHSI_DBG_PREFILL               0
  32
  33 /* Structure describing a HSI packet descriptor. */
  34 #pragma pack(1) /* Byte alignment. */
  35 struct cfhsi_desc {
  36         u8 header;
  37         u8 offset;
  38         u16 cffrm_len[CFHSI_MAX_PKTS];
  39         u8 emb_frm[CFHSI_MAX_EMB_FRM_SZ];
  40 };
  41 #pragma pack() /* Default alignment. */
  42
  43 /* Size of the complete HSI packet descriptor. */
  44 #define CFHSI_DESC_SZ (sizeof(struct cfhsi_desc))
  45
  46 /*
  47  * Size of the complete HSI packet descriptor excluding the optional embedded
  48  * CAIF frame.
  49  */
  50 #define CFHSI_DESC_SHORT_SZ (CFHSI_DESC_SZ - CFHSI_MAX_EMB_FRM_SZ)
  51
  52 /*
  53  * Maximum bytes transferred in one transfer.
  54  */
  55 #define CFHSI_MAX_CAIF_FRAME_SZ 4096
  56
  57 #define CFHSI_MAX_PAYLOAD_SZ (CFHSI_MAX_PKTS * CFHSI_MAX_CAIF_FRAME_SZ)
  58
  59 /* Size of the complete HSI TX buffer. */
  60 #define CFHSI_BUF_SZ_TX (CFHSI_DESC_SZ + CFHSI_MAX_PAYLOAD_SZ)
  61
  62 /* Size of the complete HSI RX buffer. */
  63 #define CFHSI_BUF_SZ_RX ((2 * CFHSI_DESC_SZ) + CFHSI_MAX_PAYLOAD_SZ)
  64
  65 /* Bitmasks for the HSI descriptor. */
  66 #define CFHSI_PIGGY_DESC                (0x01 << 7)
  67
  68 #define CFHSI_TX_STATE_IDLE                     0
  69 #define CFHSI_TX_STATE_XFER                     1
  70
  71 #define CFHSI_RX_STATE_DESC                     0
  72 #define CFHSI_RX_STATE_PAYLOAD                  1
  73
  74 /* Bitmasks for power management. */
  75 #define CFHSI_WAKE_UP                           0
  76 #define CFHSI_WAKE_UP_ACK                       1
  77 #define CFHSI_WAKE_DOWN_ACK                     2
  78 #define CFHSI_AWAKE                             3
  79 #define CFHSI_WAKELOCK_HELD                     4
  80 #define CFHSI_SHUTDOWN                          5
  81 #define CFHSI_FLUSH_FIFO                        6
  82
  83 #ifndef CFHSI_INACTIVITY_TOUT
  84 #define CFHSI_INACTIVITY_TOUT                   (1 * HZ)
  85 #endif /* CFHSI_INACTIVITY_TOUT */
  86
  87 #ifndef CFHSI_WAKE_TOUT
  88 #define CFHSI_WAKE_TOUT                 (3 * HZ)
  89 #endif /* CFHSI_WAKE_TOUT */
  90
  91 #ifndef CFHSI_MAX_RX_RETRIES
  92 #define CFHSI_MAX_RX_RETRIES            (10 * HZ)
  93 #endif
  94
  95 /* Structure implemented by the CAIF HSI driver. */
  96 struct cfhsi_cb_ops {
  97         void (*tx_done_cb) (struct cfhsi_cb_ops *drv);
  98         void (*rx_done_cb) (struct cfhsi_cb_ops *drv);
  99         void (*wake_up_cb) (struct cfhsi_cb_ops *drv);
 100         void (*wake_down_cb) (struct cfhsi_cb_ops *drv);
 101 };
 102
 103 /* Structure implemented by HSI device. */
 104 struct cfhsi_ops {
 105         int (*cfhsi_up) (struct cfhsi_ops *dev);
 106         int (*cfhsi_down) (struct cfhsi_ops *dev);
 107         int (*cfhsi_tx) (u8 *ptr, int len, struct cfhsi_ops *dev);
 108         int (*cfhsi_rx) (u8 *ptr, int len, struct cfhsi_ops *dev);
 109         int (*cfhsi_wake_up) (struct cfhsi_ops *dev);
 110         int (*cfhsi_wake_down) (struct cfhsi_ops *dev);
 111         int (*cfhsi_get_peer_wake) (struct cfhsi_ops *dev, bool *status);
 112         int (*cfhsi_fifo_occupancy) (struct cfhsi_ops *dev, size_t *occupancy);
 113         int (*cfhsi_rx_cancel)(struct cfhsi_ops *dev);
 114         struct cfhsi_cb_ops *cb_ops;
 115 };
 116
 117 /* Structure holds status of received CAIF frames processing */
 118 struct cfhsi_rx_state {
 119         int state;
 120         int nfrms;
 121         int pld_len;
 122         int retries;
 123         bool piggy_desc;
 124 };
 125
 126 /* Priority mapping */
 127 enum {
 128         CFHSI_PRIO_CTL = 0,
 129         CFHSI_PRIO_VI,
 130         CFHSI_PRIO_VO,
 131         CFHSI_PRIO_BEBK,
 132         CFHSI_PRIO_LAST,
 133 };
 134
 135 struct cfhsi_config {
 136         u32 inactivity_timeout;
 137         u32 aggregation_timeout;
 138         u32 head_align;
 139         u32 tail_align;
 140         u32 q_high_mark;
 141         u32 q_low_mark;
 142 };
 143
 144 /* Structure implemented by CAIF HSI drivers. */
 145 struct cfhsi {
 146         struct caif_dev_common cfdev;
 147         struct net_device *ndev;
 148         struct platform_device *pdev;
 149         struct sk_buff_head qhead[CFHSI_PRIO_LAST];
 150         struct cfhsi_cb_ops cb_ops;
 151         struct cfhsi_ops *ops;
 152         int tx_state;
 153         struct cfhsi_rx_state rx_state;
 154         struct cfhsi_config cfg;
 155         int rx_len;
 156         u8 *rx_ptr;
 157         u8 *tx_buf;
 158         u8 *rx_buf;
 159         u8 *rx_flip_buf;
 160         spinlock_t lock;
 161         int flow_off_sent;
 162         struct list_head list;
 163         struct work_struct wake_up_work;
 164         struct work_struct wake_down_work;
 165         struct work_struct out_of_sync_work;
 166         struct workqueue_struct *wq;
 167         wait_queue_head_t wake_up_wait;
 168         wait_queue_head_t wake_down_wait;
 169         wait_queue_head_t flush_fifo_wait;
 170         struct timer_list inactivity_timer;
 171         struct timer_list rx_slowpath_timer;
 172
 173         /* TX aggregation */
 174         int aggregation_len;
 175         struct timer_list aggregation_timer;
 176
 177         unsigned long bits;
 178 };
 179 extern struct platform_driver cfhsi_driver;
 180
 181 /**
 182  * enum ifla_caif_hsi - CAIF HSI NetlinkRT parameters.
 183  * @IFLA_CAIF_HSI_INACTIVITY_TOUT: Inactivity timeout before
 184  *                      taking the HSI wakeline down, in milliseconds.
 185  * When using RT Netlink to create, destroy or configure a CAIF HSI interface,
 186  * enum ifla_caif_hsi is used to specify the configuration attributes.
 187  */
 188 enum ifla_caif_hsi {
 189         __IFLA_CAIF_HSI_UNSPEC,
 190         __IFLA_CAIF_HSI_INACTIVITY_TOUT,
 191         __IFLA_CAIF_HSI_AGGREGATION_TOUT,
 192         __IFLA_CAIF_HSI_HEAD_ALIGN,
 193         __IFLA_CAIF_HSI_TAIL_ALIGN,
 194         __IFLA_CAIF_HSI_QHIGH_WATERMARK,
 195         __IFLA_CAIF_HSI_QLOW_WATERMARK,
 196         __IFLA_CAIF_HSI_MAX
 197 };
 198
 199 extern struct cfhsi_ops *cfhsi_get_ops(void);
 200
 201 #endif          /* CAIF_HSI_H_ */