sound/usb/card.h

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