Home | History | Annotate | Line # | Download | only in hdaudio
hdaudiovar.h revision 1.1 
      1 /* $NetBSD: hdaudiovar.h,v 1.1 2015/03/28 14:09:59 jmcneill Exp $ */
      2 
      3 /*
      4  * Copyright (c) 2009 Precedence Technologies Ltd <support (at) precedence.co.uk>
      5  * Copyright (c) 2009 Jared D. McNeill <jmcneill (at) invisible.ca>
      6  * All rights reserved.
      7  *
      8  * This code is derived from software contributed to The NetBSD Foundation
      9  * by Precedence Technologies Ltd
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. The name of the author may not be used to endorse or promote products
     17  *    derived from this software without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
     26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     27  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     29  * SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _HDAUDIOVAR_H
     33 #define _HDAUDIOVAR_H
     34 
     35 #include <dev/auconv.h>
     36 
     37 #include "hdaudio_config.h"
     38 
     39 #define	HDAUDIO_MAX_CODECS	15
     40 
     41 #define	hda_read1(sc, off)		\
     42 	bus_space_read_1((sc)->sc_memt, (sc)->sc_memh, (off))
     43 #define	hda_read2(sc, off)		\
     44 	bus_space_read_2((sc)->sc_memt, (sc)->sc_memh, (off))
     45 #define	hda_read4(sc, off)		\
     46 	bus_space_read_4((sc)->sc_memt, (sc)->sc_memh, (off))
     47 #define	hda_write1(sc, off, val)	\
     48 	bus_space_write_1((sc)->sc_memt, (sc)->sc_memh, (off), (val))
     49 #define	hda_write2(sc, off, val)	\
     50 	bus_space_write_2((sc)->sc_memt, (sc)->sc_memh, (off), (val))
     51 #define	hda_write4(sc, off, val)	\
     52 	bus_space_write_4((sc)->sc_memt, (sc)->sc_memh, (off), (val))
     53 #define	hda_print(sc, ...)		\
     54 	aprint_normal_dev((sc)->sc_dev, __VA_ARGS__)
     55 #define	hda_print1(sc, ...)		\
     56 	aprint_normal(__VA_ARGS__)
     57 #define	hda_error(sc, ...)		\
     58 	aprint_error_dev((sc)->sc_dev, __VA_ARGS__)
     59 #ifdef HDAUDIO_DEBUG
     60 #define	hda_trace(sc, ...)		\
     61 	aprint_normal_dev((sc)->sc_dev, __VA_ARGS__)
     62 #define	hda_trace1(sc, ...)		\
     63 	aprint_normal(__VA_ARGS__)
     64 #else
     65 #define hda_trace(sc, ...) do { } while (0)
     66 #define hda_trace1(sc, ...) do { } while (0)
     67 #endif
     68 #define	hda_delay(us)			\
     69 	delay((us))
     70 
     71 struct hdaudio_softc;
     72 
     73 enum function_group_type {
     74 	HDAUDIO_GROUP_TYPE_UNKNOWN = 0,
     75 	HDAUDIO_GROUP_TYPE_AFG,
     76 	HDAUDIO_GROUP_TYPE_VSM_FG,
     77 };
     78 
     79 struct hdaudio_function_group {
     80 	device_t			fg_device;
     81 	struct hdaudio_codec		*fg_codec;
     82 	enum function_group_type	fg_type;
     83 	int				fg_nid;
     84 	uint16_t			fg_vendor;
     85 	uint16_t			fg_product;
     86 
     87 	int				(*fg_unsol)(device_t, uint8_t);
     88 };
     89 
     90 struct hdaudio_codec {
     91 	bool				co_valid;
     92 	u_int				co_addr;
     93 	u_int				co_nfg;
     94 	struct hdaudio_function_group	*co_fg;
     95 	struct hdaudio_softc		*co_host;
     96 };
     97 
     98 #define	DMA_KERNADDR(dma)	((dma)->dma_addr)
     99 #define DMA_DMAADDR(dma)	((dma)->dma_map->dm_segs[0].ds_addr)
    100 
    101 struct hdaudio_dma {
    102 	bus_dmamap_t		dma_map;
    103 	void			*dma_addr;
    104 	bus_dma_segment_t	dma_segs[1];
    105 	int			dma_nsegs;
    106 	bus_size_t		dma_size;
    107 	bool			dma_valid;
    108 	uint8_t			dma_sizereg;
    109 };
    110 
    111 #define	HDAUDIO_MAX_STREAMS	30
    112 
    113 struct hdaudio_dma_position {
    114 	uint32_t	position;
    115 	uint32_t	reserved;
    116 } __packed;
    117 
    118 struct hdaudio_bdl_entry {
    119 	uint32_t	address_lo;
    120 	uint32_t	address_hi;
    121 	uint32_t	length;
    122 	uint32_t	flags;
    123 #define	HDAUDIO_BDL_ENTRY_IOC	0x00000001
    124 } __packed;
    125 
    126 #define	HDAUDIO_BDL_MAX		256
    127 
    128 enum hdaudio_stream_type {
    129 	HDAUDIO_STREAM_ISS = 0,
    130 	HDAUDIO_STREAM_OSS = 1,
    131 	HDAUDIO_STREAM_BSS = 2
    132 };
    133 
    134 struct hdaudio_stream {
    135 	struct hdaudio_softc		*st_host;
    136 	bool				st_enable;
    137 	enum hdaudio_stream_type	st_type;
    138 	int				st_shift;
    139 	int				st_num;
    140 
    141 	int				(*st_intr)(struct hdaudio_stream *);
    142 	void				*st_cookie;
    143 
    144 	struct hdaudio_dma		st_data;
    145 	struct hdaudio_dma		st_bdl;
    146 };
    147 
    148 struct hdaudio_softc {
    149 	device_t		sc_dev;
    150 
    151 	bus_dma_tag_t		sc_dmat;
    152 	bus_space_tag_t		sc_memt;
    153 	bus_space_handle_t	sc_memh;
    154 	bus_addr_t		sc_membase;
    155 	bus_size_t		sc_memsize;
    156 	bool			sc_memvalid;
    157 
    158 	uint32_t		sc_subsystem;
    159 
    160 	kmutex_t		sc_corb_mtx;
    161 	struct hdaudio_dma	sc_corb;
    162 	struct hdaudio_dma	sc_rirb;
    163 	uint16_t		sc_rirbrp;
    164 
    165 	struct hdaudio_codec	sc_codec[HDAUDIO_MAX_CODECS];
    166 
    167 	struct hdaudio_stream	sc_stream[HDAUDIO_MAX_STREAMS];
    168 	uint32_t		sc_stream_mask;
    169 	kmutex_t		sc_stream_mtx;
    170 };
    171 
    172 int	hdaudio_attach(device_t, struct hdaudio_softc *);
    173 int	hdaudio_detach(struct hdaudio_softc *, int);
    174 bool	hdaudio_resume(struct hdaudio_softc *);
    175 int	hdaudio_rescan(struct hdaudio_softc *, const char *, const int *);
    176 void	hdaudio_childdet(struct hdaudio_softc *, device_t);
    177 
    178 uint32_t hdaudio_command(struct hdaudio_codec *, int, uint32_t, uint32_t);
    179 uint32_t hdaudio_command_unlocked(struct hdaudio_codec *, int, uint32_t,
    180     uint32_t);
    181 int	hdaudio_intr(struct hdaudio_softc *);
    182 
    183 int	hdaudio_dma_alloc(struct hdaudio_softc *, struct hdaudio_dma *, int);
    184 void	hdaudio_dma_free(struct hdaudio_softc *, struct hdaudio_dma *);
    185 
    186 struct hdaudio_stream *	hdaudio_stream_establish(struct hdaudio_softc *,
    187 				    enum hdaudio_stream_type,
    188 				    int (*)(struct hdaudio_stream *), void *);
    189 void	hdaudio_stream_disestablish(struct hdaudio_stream *);
    190 void	hdaudio_stream_start(struct hdaudio_stream *, int, bus_size_t,
    191 			     const audio_params_t *);
    192 void	hdaudio_stream_stop(struct hdaudio_stream *);
    193 void	hdaudio_stream_reset(struct hdaudio_stream *);
    194 int	hdaudio_stream_tag(struct hdaudio_stream *);
    195 uint16_t hdaudio_stream_param(struct hdaudio_stream *, const audio_params_t *);
    196 
    197 #endif /* !_HDAUDIOVAR_H */
    198