sound/usb/card.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __USBAUDIO_CARD_H
   3 #define __USBAUDIO_CARD_H
   4
   5 #define MAX_NR_RATES    1024
   6 #define MAX_PACKS       6               /* per URB */
   7 #define MAX_PACKS_HS    (MAX_PACKS * 8) /* in high speed mode */
   8 #define MAX_URBS        12
   9 #define SYNC_URBS       4       /* always four urbs for sync */
  10 #define MAX_QUEUE       18      /* try not to exceed this queue length, in ms */
  11
  12 struct audioformat {
  13         struct list_head list;
  14         u64 formats;                    /* ALSA format bits */
  15         unsigned int channels;          /* # channels */
  16         unsigned int fmt_type;          /* USB audio format type (1-3) */
  17         unsigned int fmt_bits;          /* number of significant bits */
  18         unsigned int frame_size;        /* samples per frame for non-audio */
  19         int iface;                      /* interface number */
  20         unsigned char altsetting;       /* corresponding alternate setting */
  21         unsigned char altset_idx;       /* array index of altenate setting */
  22         unsigned char attributes;       /* corresponding attributes of cs endpoint */
  23         unsigned char endpoint;         /* endpoint */
  24         unsigned char ep_attr;          /* endpoint attributes */
  25         unsigned char datainterval;     /* log_2 of data packet interval */
  26         unsigned char protocol;         /* UAC_VERSION_1/2/3 */
  27         unsigned int maxpacksize;       /* max. packet size */
  28         unsigned int rates;             /* rate bitmasks */
  29         unsigned int rate_min, rate_max;        /* min/max rates */
  30         unsigned int nr_rates;          /* number of rate table entries */
  31         unsigned int *rate_table;       /* rate table */
  32         unsigned char clock;            /* associated clock */
  33         struct snd_pcm_chmap_elem *chmap; /* (optional) channel map */
  34         bool dsd_dop;                   /* add DOP headers in case of DSD samples */
  35         bool dsd_bitrev;                /* reverse the bits of each DSD sample */
  36         bool dsd_raw;                   /* altsetting is raw DSD */
  37 };
  38
  39 struct snd_usb_substream;
  40 struct snd_usb_endpoint;
  41 struct snd_usb_power_domain;
  42
  43 struct snd_urb_ctx {
  44         struct urb *urb;
  45         unsigned int buffer_size;       /* size of data buffer, if data URB */
  46         struct snd_usb_substream *subs;
  47         struct snd_usb_endpoint *ep;
  48         int index;      /* index for urb array */
  49         int packets;    /* number of packets per urb */
  50         int packet_size[MAX_PACKS_HS]; /* size of packets for next submission */
  51         struct list_head ready_list;
  52 };
  53
  54 struct snd_usb_endpoint {
  55         struct snd_usb_audio *chip;
  56
  57         int use_count;
  58         int ep_num;             /* the referenced endpoint number */
  59         int type;               /* SND_USB_ENDPOINT_TYPE_* */
  60         unsigned long flags;
  61
  62         void (*prepare_data_urb) (struct snd_usb_substream *subs,
  63                                   struct urb *urb);
  64         void (*retire_data_urb) (struct snd_usb_substream *subs,
  65                                  struct urb *urb);
  66
  67         struct snd_usb_substream *data_subs;
  68         struct snd_usb_endpoint *sync_master;
  69         struct snd_usb_endpoint *sync_slave;
  70
  71         struct snd_urb_ctx urb[MAX_URBS];
  72
  73         struct snd_usb_packet_info {
  74                 uint32_t packet_size[MAX_PACKS_HS];
  75                 int packets;
  76         } next_packet[MAX_URBS];
  77         int next_packet_read_pos, next_packet_write_pos;
  78         struct list_head ready_playback_urbs;
  79
  80         unsigned int nurbs;             /* # urbs */
  81         unsigned long active_mask;      /* bitmask of active urbs */
  82         unsigned long unlink_mask;      /* bitmask of unlinked urbs */
  83         char *syncbuf;                  /* sync buffer for all sync URBs */
  84         dma_addr_t sync_dma;            /* DMA address of syncbuf */
  85
  86         unsigned int pipe;              /* the data i/o pipe */
  87         unsigned int freqn;             /* nominal sampling rate in fs/fps in Q16.16 format */
  88         unsigned int freqm;             /* momentary sampling rate in fs/fps in Q16.16 format */
  89         int        freqshift;           /* how much to shift the feedback value to get Q16.16 */
  90         unsigned int freqmax;           /* maximum sampling rate, used for buffer management */
  91         unsigned int phase;             /* phase accumulator */
  92         unsigned int maxpacksize;       /* max packet size in bytes */
  93         unsigned int maxframesize;      /* max packet size in frames */
  94         unsigned int max_urb_frames;    /* max URB size in frames */
  95         unsigned int curpacksize;       /* current packet size in bytes (for capture) */
  96         unsigned int curframesize;      /* current packet size in frames (for capture) */
  97         unsigned int syncmaxsize;       /* sync endpoint packet size */
  98         unsigned int fill_max:1;        /* fill max packet size always */
  99         unsigned int tenor_fb_quirk:1;  /* corrupted feedback data */
 100         unsigned int datainterval;      /* log_2 of data packet interval */
 101         unsigned int syncinterval;      /* P for adaptive mode, 0 otherwise */
 102         unsigned char silence_value;
 103         unsigned int stride;
 104         int iface, altsetting;
 105         int skip_packets;               /* quirks for devices to ignore the first n packets
 106                                            in a stream */
 107
 108         spinlock_t lock;
 109         struct list_head list;
 110 };
 111
 112 struct media_ctl;
 113
 114 struct snd_usb_substream {
 115         struct snd_usb_stream *stream;
 116         struct usb_device *dev;
 117         struct snd_pcm_substream *pcm_substream;
 118         int direction;  /* playback or capture */
 119         int interface;  /* current interface */
 120         int endpoint;   /* assigned endpoint */
 121         struct audioformat *cur_audiofmt;       /* current audioformat pointer (for hw_params callback) */
 122         struct snd_usb_power_domain *str_pd;    /* UAC3 Power Domain for streaming path */
 123         snd_pcm_format_t pcm_format;    /* current audio format (for hw_params callback) */
 124         unsigned int channels;          /* current number of channels (for hw_params callback) */
 125         unsigned int channels_max;      /* max channels in the all audiofmts */
 126         unsigned int cur_rate;          /* current rate (for hw_params callback) */
 127         unsigned int period_bytes;      /* current period bytes (for hw_params callback) */
 128         unsigned int period_frames;     /* current frames per period */
 129         unsigned int buffer_periods;    /* current periods per buffer */
 130         unsigned int altset_idx;     /* USB data format: index of alternate setting */
 131         unsigned int txfr_quirk:1;      /* allow sub-frame alignment */
 132         unsigned int tx_length_quirk:1; /* add length specifier to transfers */
 133         unsigned int fmt_type;          /* USB audio format type (1-3) */
 134         unsigned int pkt_offset_adj;    /* Bytes to drop from beginning of packets (for non-compliant devices) */
 135
 136         unsigned int running: 1;        /* running status */
 137
 138         unsigned int hwptr_done;        /* processed byte position in the buffer */
 139         unsigned int transfer_done;             /* processed frames since last period update */
 140         unsigned int frame_limit;       /* limits number of packets in URB */
 141
 142         /* data and sync endpoints for this stream */
 143         unsigned int ep_num;            /* the endpoint number */
 144         struct snd_usb_endpoint *data_endpoint;
 145         struct snd_usb_endpoint *sync_endpoint;
 146         unsigned long flags;
 147         bool need_setup_ep;             /* (re)configure EP at prepare? */
 148         bool need_setup_fmt;            /* (re)configure fmt after resume? */
 149         unsigned int speed;             /* USB_SPEED_XXX */
 150
 151         u64 formats;                    /* format bitmasks (all or'ed) */
 152         unsigned int num_formats;               /* number of supported audio formats (list) */
 153         struct list_head fmt_list;      /* format list */
 154         struct snd_pcm_hw_constraint_list rate_list;    /* limited rates */
 155         spinlock_t lock;
 156
 157         int last_frame_number;          /* stored frame number */
 158         int last_delay;                 /* stored delay */
 159
 160         struct {
 161                 int marker;
 162                 int channel;
 163                 int byte_idx;
 164         } dsd_dop;
 165
 166         bool trigger_tstamp_pending_update; /* trigger timestamp being updated from initial estimate */
 167         struct media_ctl *media_ctl;
 168 };
 169
 170 struct snd_usb_stream {
 171         struct snd_usb_audio *chip;
 172         struct snd_pcm *pcm;
 173         int pcm_index;
 174         unsigned int fmt_type;          /* USB audio format type (1-3) */
 175         struct snd_usb_substream substream[2];
 176         struct list_head list;
 177 };
 178
 179 #endif /* __USBAUDIO_CARD_H */