sys/dev/sound/pcm/channel.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
   5  * Portions Copyright (c) Ryan Beasley <ryan.beasley@gmail.com> - GSoC 2006
   6  * Copyright (c) 1999 Cameron Grant <cg@FreeBSD.org>
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 struct pcmchan_caps {
  32         u_int32_t minspeed, maxspeed;
  33         u_int32_t *fmtlist;
  34         u_int32_t caps;
  35 };
  36
  37 struct pcmchan_matrix {
  38         int id;
  39         uint8_t channels, ext;
  40         struct {
  41                 int type;
  42                 uint32_t members;
  43         } map[SND_CHN_T_MAX + 1];
  44         uint32_t mask;
  45         int8_t offset[SND_CHN_T_MAX];
  46 };
  47
  48 /* Forward declarations */
  49 struct pcm_channel;
  50 struct pcmchan_syncgroup;
  51 struct pcmchan_syncmember;
  52
  53 extern struct mtx snd_pcm_syncgroups_mtx;
  54 extern SLIST_HEAD(pcm_synclist, pcmchan_syncgroup) snd_pcm_syncgroups;
  55
  56 #define PCM_SG_LOCK()       mtx_lock(&snd_pcm_syncgroups_mtx)
  57 #define PCM_SG_TRYLOCK()    mtx_trylock(&snd_pcm_syncgroups_mtx)
  58 #define PCM_SG_UNLOCK()     mtx_unlock(&snd_pcm_syncgroups_mtx)
  59 #define PCM_SG_LOCKASSERT(arg)  mtx_assert(&snd_pcm_syncgroups_mtx, arg)
  60
  61 /**
  62  * @brief Specifies an audio device sync group
  63  */
  64 struct pcmchan_syncgroup {
  65         SLIST_ENTRY(pcmchan_syncgroup) link;
  66         SLIST_HEAD(, pcmchan_syncmember) members;
  67         int id; /**< Group identifier; set to address of group. */
  68 };
  69
  70 /**
  71  * @brief Specifies a container for members of a sync group
  72  */
  73 struct pcmchan_syncmember {
  74         SLIST_ENTRY(pcmchan_syncmember) link;
  75         struct pcmchan_syncgroup *parent; /**< group head */
  76         struct pcm_channel *ch;
  77 };
  78
  79 #define CHN_NAMELEN             32
  80 #define CHN_COMM_UNUSED         "<UNUSED>"
  81 #define CHN_COMM_UNKNOWN        "<UNKNOWN>"
  82
  83 struct pcm_channel {
  84         kobj_t methods;
  85
  86         pid_t pid;
  87         int refcount;
  88         struct pcm_feeder *feeder;
  89         u_int32_t align;
  90
  91         int latency;
  92         u_int32_t speed;
  93         u_int32_t format;
  94         u_int32_t flags;
  95         u_int32_t feederflags;
  96         u_int64_t blocks;
  97
  98         int direction;
  99         unsigned int interrupts, xruns, feedcount;
 100         unsigned int timeout;
 101         struct snd_dbuf *bufhard, *bufsoft;
 102         struct snddev_info *parentsnddev;
 103         struct pcm_channel *parentchannel;
 104         void *devinfo;
 105         device_t dev;
 106         int unit;
 107         int type;
 108         char name[CHN_NAMELEN];
 109         char comm[MAXCOMLEN + 1];
 110         struct mtx *lock;
 111         int trigger;
 112         /**
 113          * For interrupt manipulations.
 114          */
 115         struct cv intr_cv;
 116         /**
 117          * Increment,decrement this around operations that temporarily yield
 118          * lock.
 119          */
 120         unsigned int inprog;
 121         /**
 122          * Special channel operations should examine @c inprog after acquiring
 123          * lock.  If zero, operations may continue.  Else, thread should
 124          * wait on this cv for previous operation to finish.
 125          */
 126         struct cv cv;
 127         /**
 128          * Low water mark for select()/poll().
 129          *
 130          * This is initialized to the channel's fragment size, and will be
 131          * overwritten if a new fragment size is set.  Users may alter this
 132          * value directly with the @c SNDCTL_DSP_LOW_WATER ioctl.
 133          */
 134         unsigned int lw;
 135         /**
 136          * If part of a sync group, this will point to the syncmember
 137          * container.
 138          */
 139         struct pcmchan_syncmember *sm;
 140 #ifdef OSSV4_EXPERIMENT
 141         u_int16_t lpeak, rpeak; /**< Peak value from 0-32767. */
 142 #endif
 143
 144         struct {
 145                 SLIST_HEAD(, pcm_channel) head;
 146                 SLIST_ENTRY(pcm_channel) link;
 147                 struct {
 148                         SLIST_HEAD(, pcm_channel) head;
 149                         SLIST_ENTRY(pcm_channel) link;
 150                 } busy;
 151         } children;
 152
 153         struct {
 154                 struct {
 155                         SLIST_ENTRY(pcm_channel) link;
 156                         struct {
 157                                 SLIST_ENTRY(pcm_channel) link;
 158                         } busy;
 159                         struct {
 160                                 SLIST_ENTRY(pcm_channel) link;
 161                         } opened;
 162                 } pcm;
 163         } channels;
 164
 165         struct pcmchan_matrix matrix;
 166         struct pcmchan_matrix matrix_scratch;
 167
 168         int16_t volume[SND_VOL_C_MAX][SND_CHN_T_VOL_MAX];
 169         int8_t muted[SND_VOL_C_MAX][SND_CHN_T_VOL_MAX];
 170
 171         void *data1, *data2;
 172 };
 173
 174 #define CHN_HEAD(x, y)                  &(x)->y.head
 175 #define CHN_INIT(x, y)                  SLIST_INIT(CHN_HEAD(x, y))
 176 #define CHN_LINK(y)                     y.link
 177 #define CHN_EMPTY(x, y)                 SLIST_EMPTY(CHN_HEAD(x, y))
 178 #define CHN_FIRST(x, y)                 SLIST_FIRST(CHN_HEAD(x, y))
 179
 180 #define CHN_FOREACH(x, y, z)                                            \
 181         SLIST_FOREACH(x, CHN_HEAD(y, z), CHN_LINK(z))
 182
 183 #define CHN_FOREACH_SAFE(w, x, y, z)                                    \
 184         SLIST_FOREACH_SAFE(w, CHN_HEAD(x, z), CHN_LINK(z), y)
 185
 186 #define CHN_INSERT_HEAD(x, y, z)                                        \
 187         SLIST_INSERT_HEAD(CHN_HEAD(x, z), y, CHN_LINK(z))
 188
 189 #define CHN_INSERT_AFTER(x, y, z)                                       \
 190         SLIST_INSERT_AFTER(x, y, CHN_LINK(z))
 191
 192 #define CHN_REMOVE(x, y, z)                                             \
 193         SLIST_REMOVE(CHN_HEAD(x, z), y, pcm_channel, CHN_LINK(z))
 194
 195 #define CHN_INSERT_HEAD_SAFE(x, y, z)           do {                    \
 196         struct pcm_channel *t = NULL;                                   \
 197         CHN_FOREACH(t, x, z) {                                          \
 198                 if (t == y)                                             \
 199                         break;                                          \
 200         }                                                               \
 201         if (t != y)                                                     \
 202                 CHN_INSERT_HEAD(x, y, z);                               \
 203 } while (0)
 204
 205 #define CHN_INSERT_AFTER_SAFE(w, x, y, z)       do {                    \
 206         struct pcm_channel *t = NULL;                                   \
 207         CHN_FOREACH(t, w, z) {                                          \
 208                 if (t == y)                                             \
 209                         break;                                          \
 210         }                                                               \
 211         if (t != y)                                                     \
 212                 CHN_INSERT_AFTER(x, y, z);                              \
 213 } while (0)
 214
 215 #define CHN_REMOVE_SAFE(x, y, z)                do {                    \
 216         struct pcm_channel *t = NULL;                                   \
 217         CHN_FOREACH(t, x, z) {                                          \
 218                 if (t == y)                                             \
 219                         break;                                          \
 220         }                                                               \
 221         if (t == y)                                                     \
 222                 CHN_REMOVE(x, y, z);                                    \
 223 } while (0)
 224
 225 #define CHN_INSERT_SORT(w, x, y, z)             do {                    \
 226         struct pcm_channel *t, *a = NULL;                               \
 227         CHN_FOREACH(t, x, z) {                                          \
 228                 if ((y)->type w t->type)                                \
 229                         a = t;                                          \
 230                 else                                                    \
 231                         break;                                          \
 232         }                                                               \
 233         if (a != NULL)                                                  \
 234                 CHN_INSERT_AFTER(a, y, z);                              \
 235         else                                                            \
 236                 CHN_INSERT_HEAD(x, y, z);                               \
 237 } while (0)
 238
 239 #define CHN_INSERT_SORT_ASCEND(x, y, z)         CHN_INSERT_SORT(>=, x, y, z)
 240 #define CHN_INSERT_SORT_DESCEND(x, y, z)        CHN_INSERT_SORT(<, x, y, z)
 241
 242 #define CHN_BUF_PARENT(x, y)                                            \
 243         (((x) != NULL && (x)->parentchannel != NULL &&                  \
 244         (x)->parentchannel->bufhard != NULL) ?                          \
 245         (x)->parentchannel->bufhard : (y))
 246
 247 #define CHN_BROADCAST(x)        do {                                    \
 248         if ((x)->cv_waiters != 0)                                       \
 249                 cv_broadcastpri(x, PRIBIO);                             \
 250 } while (0)
 251
 252 #include "channel_if.h"
 253
 254 int chn_reinit(struct pcm_channel *c);
 255 int chn_write(struct pcm_channel *c, struct uio *buf);
 256 int chn_read(struct pcm_channel *c, struct uio *buf);
 257 u_int32_t chn_start(struct pcm_channel *c, int force);
 258 int chn_sync(struct pcm_channel *c, int threshold);
 259 int chn_flush(struct pcm_channel *c);
 260 int chn_poll(struct pcm_channel *c, int ev, struct thread *td);
 261
 262 int chn_init(struct pcm_channel *c, void *devinfo, int dir, int direction);
 263 void chn_kill(struct pcm_channel *c);
 264 void chn_shutdown(struct pcm_channel *c);
 265 int chn_reset(struct pcm_channel *c, u_int32_t fmt, u_int32_t spd);
 266 int chn_setvolume_multi(struct pcm_channel *c, int vc, int left, int right,
 267     int center);
 268 int chn_setvolume_matrix(struct pcm_channel *c, int vc, int vt, int val);
 269 int chn_getvolume_matrix(struct pcm_channel *c, int vc, int vt);
 270 int chn_setmute_multi(struct pcm_channel *c, int vc, int mute);
 271 int chn_setmute_matrix(struct pcm_channel *c, int vc, int vt, int mute);
 272 int chn_getmute_matrix(struct pcm_channel *c, int vc, int vt);
 273 void chn_vpc_reset(struct pcm_channel *c, int vc, int force);
 274 int chn_setparam(struct pcm_channel *c, uint32_t format, uint32_t speed);
 275 int chn_setspeed(struct pcm_channel *c, uint32_t speed);
 276 int chn_setformat(struct pcm_channel *c, uint32_t format);
 277 int chn_setblocksize(struct pcm_channel *c, int blkcnt, int blksz);
 278 int chn_setlatency(struct pcm_channel *c, int latency);
 279 void chn_syncstate(struct pcm_channel *c);
 280 int chn_trigger(struct pcm_channel *c, int go);
 281 int chn_getptr(struct pcm_channel *c);
 282 struct pcmchan_caps *chn_getcaps(struct pcm_channel *c);
 283 u_int32_t chn_getformats(struct pcm_channel *c);
 284
 285 struct pcmchan_matrix *chn_getmatrix(struct pcm_channel *);
 286 int chn_setmatrix(struct pcm_channel *, struct pcmchan_matrix *);
 287
 288 int chn_oss_getorder(struct pcm_channel *, unsigned long long *);
 289 int chn_oss_setorder(struct pcm_channel *, unsigned long long *);
 290 int chn_oss_getmask(struct pcm_channel *, uint32_t *);
 291
 292 void chn_resetbuf(struct pcm_channel *c);
 293 void chn_intr_locked(struct pcm_channel *c);
 294 void chn_intr(struct pcm_channel *c);
 295 int chn_abort(struct pcm_channel *c);
 296
 297 int chn_notify(struct pcm_channel *c, u_int32_t flags);
 298
 299 int chn_getrates(struct pcm_channel *c, int **rates);
 300 int chn_syncdestroy(struct pcm_channel *c);
 301
 302 #define CHN_SETVOLUME(...)              chn_setvolume_matrix(__VA_ARGS__)
 303 #if defined(SND_DIAGNOSTIC) || defined(INVARIANTS)
 304 #define CHN_GETVOLUME(...)              chn_getvolume_matrix(__VA_ARGS__)
 305 #else
 306 #define CHN_GETVOLUME(x, y, z)          ((x)->volume[y][z])
 307 #endif
 308
 309 #define CHN_GETMUTE(x, y, z)            ((x)->muted[y][z])
 310
 311 #ifdef OSSV4_EXPERIMENT
 312 int chn_getpeaks(struct pcm_channel *c, int *lpeak, int *rpeak);
 313 #endif
 314
 315 #define CHN_LOCKOWNED(c)        mtx_owned((c)->lock)
 316 #define CHN_LOCK(c)             mtx_lock((c)->lock)
 317 #define CHN_UNLOCK(c)           mtx_unlock((c)->lock)
 318 #define CHN_TRYLOCK(c)          mtx_trylock((c)->lock)
 319 #define CHN_LOCKASSERT(c)       mtx_assert((c)->lock, MA_OWNED)
 320 #define CHN_UNLOCKASSERT(c)     mtx_assert((c)->lock, MA_NOTOWNED)
 321
 322 int snd_fmtvalid(uint32_t fmt, uint32_t *fmtlist);
 323
 324 uint32_t snd_str2afmt(const char *);
 325 uint32_t snd_afmt2str(uint32_t, char *, size_t);
 326
 327 #define AFMTSTR_LEN     16
 328
 329 extern int chn_latency;
 330 extern int chn_latency_profile;
 331 extern int report_soft_formats;
 332 extern int report_soft_matrix;
 333
 334 #define PCMDIR_PLAY             1
 335 #define PCMDIR_PLAY_VIRTUAL     2
 336 #define PCMDIR_REC              -1
 337 #define PCMDIR_REC_VIRTUAL      -2
 338
 339 #define PCMTRIG_START 1
 340 #define PCMTRIG_EMLDMAWR 2
 341 #define PCMTRIG_EMLDMARD 3
 342 #define PCMTRIG_STOP 0
 343 #define PCMTRIG_ABORT -1
 344
 345 #define PCMTRIG_COMMON(x)       ((x) == PCMTRIG_START ||                \
 346                                  (x) == PCMTRIG_STOP ||                 \
 347                                  (x) == PCMTRIG_ABORT)
 348
 349 #define CHN_F_CLOSING           0x00000001  /* a pending close */
 350 #define CHN_F_ABORTING          0x00000002  /* a pending abort */
 351 #define CHN_F_RUNNING           0x00000004  /* dma is running */
 352 #define CHN_F_TRIGGERED         0x00000008
 353 #define CHN_F_NOTRIGGER         0x00000010
 354 #define CHN_F_SLEEPING          0x00000020
 355
 356 #define CHN_F_NBIO              0x00000040  /* do non-blocking i/o */
 357 #define CHN_F_MMAP              0x00000080  /* has been mmap()ed */
 358
 359 #define CHN_F_BUSY              0x00000100  /* has been opened  */
 360 #define CHN_F_DIRTY             0x00000200  /* need re-config */
 361 #define CHN_F_DEAD              0x00000400  /* too many errors, dead, mdk */
 362 #define CHN_F_SILENCE           0x00000800  /* silence, nil, null, yada */
 363
 364 #define CHN_F_HAS_SIZE          0x00001000  /* user set block size */
 365 #define CHN_F_HAS_VCHAN         0x00002000  /* vchan master */
 366
 367 #define CHN_F_VCHAN_PASSTHROUGH 0x00004000  /* digital ac3/dts passthrough */
 368 #define CHN_F_VCHAN_ADAPTIVE    0x00008000  /* adaptive format/rate selection */
 369 #define CHN_F_VCHAN_DYNAMIC     (CHN_F_VCHAN_PASSTHROUGH | CHN_F_VCHAN_ADAPTIVE)
 370
 371 #define CHN_F_VIRTUAL           0x10000000  /* not backed by hardware */
 372 #define CHN_F_BITPERFECT        0x20000000  /* un-cooked, Heh.. */
 373 #define CHN_F_PASSTHROUGH       0x40000000  /* passthrough re-config */
 374 #define CHN_F_EXCLUSIVE         0x80000000  /* exclusive access */
 375
 376 #define CHN_F_BITS              "\020"                                  \
 377                                 "\001CLOSING"                           \
 378                                 "\002ABORTING"                          \
 379                                 "\003RUNNING"                           \
 380                                 "\004TRIGGERED"                         \
 381                                 "\005NOTRIGGER"                         \
 382                                 "\006SLEEPING"                          \
 383                                 "\007NBIO"                              \
 384                                 "\010MMAP"                              \
 385                                 "\011BUSY"                              \
 386                                 "\012DIRTY"                             \
 387                                 "\013DEAD"                              \
 388                                 "\014SILENCE"                           \
 389                                 "\015HAS_SIZE"                          \
 390                                 "\016HAS_VCHAN"                         \
 391                                 "\017VCHAN_PASSTHROUGH"                 \
 392                                 "\020VCHAN_ADAPTIVE"                    \
 393                                 "\035VIRTUAL"                           \
 394                                 "\036BITPERFECT"                        \
 395                                 "\037PASSTHROUGH"                       \
 396                                 "\040EXCLUSIVE"
 397
 398 #define CHN_F_RESET             (CHN_F_BUSY | CHN_F_DEAD |              \
 399                                  CHN_F_VIRTUAL | CHN_F_HAS_VCHAN |      \
 400                                  CHN_F_VCHAN_DYNAMIC |                  \
 401                                  CHN_F_PASSTHROUGH | CHN_F_EXCLUSIVE)
 402
 403 #define CHN_F_MMAP_INVALID      (CHN_F_DEAD | CHN_F_RUNNING)
 404
 405
 406
 407 #define CHN_N_RATE              0x00000001
 408 #define CHN_N_FORMAT            0x00000002
 409 #define CHN_N_VOLUME            0x00000004
 410 #define CHN_N_BLOCKSIZE         0x00000008
 411 #define CHN_N_TRIGGER           0x00000010
 412
 413 #define CHN_LATENCY_MIN         0
 414 #define CHN_LATENCY_MAX         10
 415 #define CHN_LATENCY_DEFAULT     2       /* 21.3ms total buffering */
 416 #define CHN_POLICY_MIN          CHN_LATENCY_MIN
 417 #define CHN_POLICY_MAX          CHN_LATENCY_MAX
 418 #define CHN_POLICY_DEFAULT      CHN_LATENCY_DEFAULT
 419
 420 #define CHN_LATENCY_PROFILE_MIN         0
 421 #define CHN_LATENCY_PROFILE_MAX         1
 422 #define CHN_LATENCY_PROFILE_DEFAULT     CHN_LATENCY_PROFILE_MAX
 423
 424 #define CHN_STARTED(c)          ((c)->flags & CHN_F_TRIGGERED)
 425 #define CHN_STOPPED(c)          (!CHN_STARTED(c))
 426 #define CHN_DIRSTR(c)           (((c)->direction == PCMDIR_PLAY) ? \
 427                                 "PCMDIR_PLAY" : "PCMDIR_REC")
 428 #define CHN_BITPERFECT(c)       ((c)->flags & CHN_F_BITPERFECT)
 429 #define CHN_PASSTHROUGH(c)      ((c)->flags & CHN_F_PASSTHROUGH)
 430
 431 #define CHN_TIMEOUT             5
 432 #define CHN_TIMEOUT_MIN         1
 433 #define CHN_TIMEOUT_MAX         10
 434
 435 /*
 436  * This should be large enough to hold all pcm data between
 437  * tsleeps in chn_{read,write} at the highest sample rate.
 438  * (which is usually 48kHz * 16bit * stereo = 192000 bytes/sec)
 439  */
 440 #define CHN_2NDBUFBLKSIZE       (2 * 1024)
 441 /* The total number of blocks per secondary bufhard. */
 442 #define CHN_2NDBUFBLKNUM        (32)
 443 /* The size of a whole secondary bufhard. */
 444 #define CHN_2NDBUFMAXSIZE       (131072)
 445
 446 #define CHANNEL_DECLARE(name) static DEFINE_CLASS(name, name ## _methods, sizeof(struct kobj))