uspace/drv/audio/hdaudio/stream.h

   1 /*
   2  * Copyright (c) 2014 Jiri Svoboda
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup hdaudio
  30  * @{
  31  */
  32 /** @file High Definition Audio stream
  33  */
  34
  35 #ifndef STREAM_H
  36 #define STREAM_H
  37
  38 #include "hdaudio.h"
  39 #include "spec/bdl.h"
  40
  41 typedef enum {
  42         /** Input Stream */
  43         sdir_input,
  44         /** Output Stream */
  45         sdir_output,
  46         /** Bidirectional Stream */
  47         sdir_bidi
  48 } hda_stream_dir_t;
  49
  50 typedef struct hda_stream_buffers {
  51         /** Number of buffers */
  52         size_t nbuffers;
  53         /** Buffer size */
  54         size_t bufsize;
  55         /** Buffer Descriptor List */
  56         hda_buffer_desc_t *bdl;
  57         /** Physical address of BDL */
  58         uintptr_t bdl_phys;
  59         /** Buffers */
  60         void **buf;
  61         /** Physical addresses of buffers */
  62         uintptr_t *buf_phys;
  63 } hda_stream_buffers_t;
  64
  65 typedef struct hda_stream {
  66         hda_t *hda;
  67         /** Stream ID */
  68         uint8_t sid;
  69         /** Stream descriptor index */
  70         uint8_t sdid;
  71         /** Direction */
  72         hda_stream_dir_t dir;
  73         /** Buffers */
  74         hda_stream_buffers_t *buffers;
  75         /** Stream format */
  76         uint32_t fmt;
  77 } hda_stream_t;
  78
  79 extern errno_t hda_stream_buffers_alloc(hda_t *, hda_stream_buffers_t **);
  80 extern void hda_stream_buffers_free(hda_stream_buffers_t *);
  81 extern hda_stream_t *hda_stream_create(hda_t *, hda_stream_dir_t,
  82     hda_stream_buffers_t *, uint32_t);
  83 extern void hda_stream_destroy(hda_stream_t *);
  84 extern void hda_stream_start(hda_stream_t *);
  85 extern void hda_stream_stop(hda_stream_t *);
  86 extern void hda_stream_reset(hda_stream_t *);
  87
  88 #endif
  89
  90 /** @}
  91  */