linux/drivers/usb/host/xhci-dbgcap.h
<<
>>
Prefs
   1/* SPDX-License-Identifier: GPL-2.0 */
   2/**
   3 * xhci-dbgcap.h - xHCI debug capability support
   4 *
   5 * Copyright (C) 2017 Intel Corporation
   6 *
   7 * Author: Lu Baolu <baolu.lu@linux.intel.com>
   8 */
   9#ifndef __LINUX_XHCI_DBGCAP_H
  10#define __LINUX_XHCI_DBGCAP_H
  11
  12#include <linux/tty.h>
  13#include <linux/kfifo.h>
  14
  15struct dbc_regs {
  16        __le32  capability;
  17        __le32  doorbell;
  18        __le32  ersts;          /* Event Ring Segment Table Size*/
  19        __le32  __reserved_0;   /* 0c~0f reserved bits */
  20        __le64  erstba;         /* Event Ring Segment Table Base Address */
  21        __le64  erdp;           /* Event Ring Dequeue Pointer */
  22        __le32  control;
  23        __le32  status;
  24        __le32  portsc;         /* Port status and control */
  25        __le32  __reserved_1;   /* 2b~28 reserved bits */
  26        __le64  dccp;           /* Debug Capability Context Pointer */
  27        __le32  devinfo1;       /* Device Descriptor Info Register 1 */
  28        __le32  devinfo2;       /* Device Descriptor Info Register 2 */
  29};
  30
  31struct dbc_info_context {
  32        __le64  string0;
  33        __le64  manufacturer;
  34        __le64  product;
  35        __le64  serial;
  36        __le32  length;
  37        __le32  __reserved_0[7];
  38};
  39
  40#define DBC_CTRL_DBC_RUN                BIT(0)
  41#define DBC_CTRL_PORT_ENABLE            BIT(1)
  42#define DBC_CTRL_HALT_OUT_TR            BIT(2)
  43#define DBC_CTRL_HALT_IN_TR             BIT(3)
  44#define DBC_CTRL_DBC_RUN_CHANGE         BIT(4)
  45#define DBC_CTRL_DBC_ENABLE             BIT(31)
  46#define DBC_CTRL_MAXBURST(p)            (((p) >> 16) & 0xff)
  47#define DBC_DOOR_BELL_TARGET(p)         (((p) & 0xff) << 8)
  48
  49#define DBC_MAX_PACKET                  1024
  50#define DBC_MAX_STRING_LENGTH           64
  51#define DBC_STRING_MANUFACTURER         "Linux Foundation"
  52#define DBC_STRING_PRODUCT              "Linux USB Debug Target"
  53#define DBC_STRING_SERIAL               "0001"
  54#define DBC_CONTEXT_SIZE                64
  55
  56/*
  57 * Port status:
  58 */
  59#define DBC_PORTSC_CONN_STATUS          BIT(0)
  60#define DBC_PORTSC_PORT_ENABLED         BIT(1)
  61#define DBC_PORTSC_CONN_CHANGE          BIT(17)
  62#define DBC_PORTSC_RESET_CHANGE         BIT(21)
  63#define DBC_PORTSC_LINK_CHANGE          BIT(22)
  64#define DBC_PORTSC_CONFIG_CHANGE        BIT(23)
  65
  66struct dbc_str_descs {
  67        char    string0[DBC_MAX_STRING_LENGTH];
  68        char    manufacturer[DBC_MAX_STRING_LENGTH];
  69        char    product[DBC_MAX_STRING_LENGTH];
  70        char    serial[DBC_MAX_STRING_LENGTH];
  71};
  72
  73#define DBC_PROTOCOL                    1       /* GNU Remote Debug Command */
  74#define DBC_VENDOR_ID                   0x1d6b  /* Linux Foundation 0x1d6b */
  75#define DBC_PRODUCT_ID                  0x0010  /* device 0010 */
  76#define DBC_DEVICE_REV                  0x0010  /* 0.10 */
  77
  78enum dbc_state {
  79        DS_DISABLED = 0,
  80        DS_INITIALIZED,
  81        DS_ENABLED,
  82        DS_CONNECTED,
  83        DS_CONFIGURED,
  84        DS_STALLED,
  85};
  86
  87struct dbc_ep {
  88        struct xhci_dbc                 *dbc;
  89        struct list_head                list_pending;
  90        struct xhci_ring                *ring;
  91        unsigned int                    direction:1;
  92};
  93
  94#define DBC_QUEUE_SIZE                  16
  95#define DBC_WRITE_BUF_SIZE              8192
  96
  97/*
  98 * Private structure for DbC hardware state:
  99 */
 100struct dbc_port {
 101        struct tty_port                 port;
 102        spinlock_t                      port_lock;      /* port access */
 103
 104        struct list_head                read_pool;
 105        struct list_head                read_queue;
 106        unsigned int                    n_read;
 107        struct tasklet_struct           push;
 108
 109        struct list_head                write_pool;
 110        struct kfifo                    write_fifo;
 111
 112        bool                            registered;
 113};
 114
 115struct dbc_driver {
 116        int (*configure)(struct xhci_dbc *dbc);
 117        void (*disconnect)(struct xhci_dbc *dbc);
 118};
 119
 120struct xhci_dbc {
 121        spinlock_t                      lock;           /* device access */
 122        struct device                   *dev;
 123        struct xhci_hcd                 *xhci;
 124        struct dbc_regs __iomem         *regs;
 125        struct xhci_ring                *ring_evt;
 126        struct xhci_ring                *ring_in;
 127        struct xhci_ring                *ring_out;
 128        struct xhci_erst                erst;
 129        struct xhci_container_ctx       *ctx;
 130
 131        struct dbc_str_descs            *string;
 132        dma_addr_t                      string_dma;
 133        size_t                          string_size;
 134
 135        enum dbc_state                  state;
 136        struct delayed_work             event_work;
 137        unsigned                        resume_required:1;
 138        struct dbc_ep                   eps[2];
 139
 140        const struct dbc_driver         *driver;
 141        void                            *priv;
 142};
 143
 144struct dbc_request {
 145        void                            *buf;
 146        unsigned int                    length;
 147        dma_addr_t                      dma;
 148        void                            (*complete)(struct xhci_dbc *dbc,
 149                                                    struct dbc_request *req);
 150        struct list_head                list_pool;
 151        int                             status;
 152        unsigned int                    actual;
 153
 154        struct xhci_dbc                 *dbc;
 155        struct list_head                list_pending;
 156        dma_addr_t                      trb_dma;
 157        union xhci_trb                  *trb;
 158        unsigned                        direction:1;
 159};
 160
 161#define dbc_bulkout_ctx(d)              \
 162        ((struct xhci_ep_ctx *)((d)->ctx->bytes + DBC_CONTEXT_SIZE))
 163#define dbc_bulkin_ctx(d)               \
 164        ((struct xhci_ep_ctx *)((d)->ctx->bytes + DBC_CONTEXT_SIZE * 2))
 165#define dbc_bulkout_enq(d)              \
 166        xhci_trb_virt_to_dma((d)->ring_out->enq_seg, (d)->ring_out->enqueue)
 167#define dbc_bulkin_enq(d)               \
 168        xhci_trb_virt_to_dma((d)->ring_in->enq_seg, (d)->ring_in->enqueue)
 169#define dbc_epctx_info2(t, p, b)        \
 170        cpu_to_le32(EP_TYPE(t) | MAX_PACKET(p) | MAX_BURST(b))
 171#define dbc_ep_dma_direction(d)         \
 172        ((d)->direction ? DMA_FROM_DEVICE : DMA_TO_DEVICE)
 173
 174#define BULK_OUT                        0
 175#define BULK_IN                         1
 176#define EPID_OUT                        2
 177#define EPID_IN                         3
 178
 179enum evtreturn {
 180        EVT_ERR = -1,
 181        EVT_DONE,
 182        EVT_GSER,
 183        EVT_DISC,
 184};
 185
 186static inline struct dbc_ep *get_in_ep(struct xhci_dbc *dbc)
 187{
 188        return &dbc->eps[BULK_IN];
 189}
 190
 191static inline struct dbc_ep *get_out_ep(struct xhci_dbc *dbc)
 192{
 193        return &dbc->eps[BULK_OUT];
 194}
 195
 196#ifdef CONFIG_USB_XHCI_DBGCAP
 197int xhci_dbc_init(struct xhci_hcd *xhci);
 198void xhci_dbc_exit(struct xhci_hcd *xhci);
 199int xhci_dbc_tty_probe(struct xhci_hcd *xhci);
 200void xhci_dbc_tty_remove(struct xhci_dbc *dbc);
 201struct dbc_request *dbc_alloc_request(struct xhci_dbc *dbc,
 202                                      unsigned int direction,
 203                                      gfp_t flags);
 204void dbc_free_request(struct dbc_request *req);
 205int dbc_ep_queue(struct dbc_request *req);
 206#ifdef CONFIG_PM
 207int xhci_dbc_suspend(struct xhci_hcd *xhci);
 208int xhci_dbc_resume(struct xhci_hcd *xhci);
 209#endif /* CONFIG_PM */
 210#else
 211static inline int xhci_dbc_init(struct xhci_hcd *xhci)
 212{
 213        return 0;
 214}
 215
 216static inline void xhci_dbc_exit(struct xhci_hcd *xhci)
 217{
 218}
 219
 220static inline int xhci_dbc_suspend(struct xhci_hcd *xhci)
 221{
 222        return 0;
 223}
 224
 225static inline int xhci_dbc_resume(struct xhci_hcd *xhci)
 226{
 227        return 0;
 228}
 229#endif /* CONFIG_USB_XHCI_DBGCAP */
 230#endif /* __LINUX_XHCI_DBGCAP_H */
 231