Home | History | Annotate | Line # | Download | only in pci
cs428x.h revision 1.7
      1 /*	$NetBSD: cs428x.h,v 1.7 2005/01/10 22:01:37 kent Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2000 Tatoku Ogaito.  All rights reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. 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  * 3. All advertising materials mentioning features or use of this software
     15  *    must display the following acknowledgement:
     16  *      This product includes software developed by Tatoku Ogaito
     17  *	for the NetBSD Project.
     18  * 4. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 /* Common functions and variables for CS4280 and CS4281 */
     34 
     35 #ifndef _CS428X_H_
     36 #define _CS428X_H_
     37 
     38 #define PCI_BA0               (0x10)
     39 #define PCI_BA1               (0x14)
     40 
     41 #define CS428X_SAVE_REG_MAX   (0x10)
     42 #define TYPE_CS4280           (0x4280)
     43 #define TYPE_CS4281           (0x4281)
     44 
     45 #define BA0READ4(sc, r) bus_space_read_4((sc)->ba0t, (sc)->ba0h, (r))
     46 #define BA0WRITE4(sc, r, x) bus_space_write_4((sc)->ba0t, (sc)->ba0h, (r), (x))
     47 
     48 /* DMA */
     49 struct cs428x_dma {
     50 	bus_dmamap_t map;
     51 	caddr_t addr;		/* real DMA buffer */
     52 	caddr_t dum;		/* dummy buffer for audio driver */
     53 	bus_dma_segment_t segs[1];
     54 	int nsegs;
     55 	size_t size;
     56 	struct cs428x_dma *next;
     57 };
     58 #define DMAADDR(p) ((p)->map->dm_segs[0].ds_addr)
     59 #define KERNADDR(p) ((void *)((p)->addr)) /* buffer for real DMA */
     60 #define BUFADDR(p)  ((void *)((p)->dum))  /* buffer for audio driver */
     61 
     62 /*
     63  * Software state
     64  */
     65 struct cs428x_softc {
     66 	struct device	      sc_dev;
     67 
     68 	pci_intr_handle_t *   sc_ih;
     69 
     70 	/* I/O (BA0) */
     71 	bus_space_tag_t	      ba0t;
     72 	bus_space_handle_t    ba0h;
     73 
     74 	/* BA1 */
     75 	bus_space_tag_t	      ba1t;
     76 	bus_space_handle_t    ba1h;
     77 
     78 	/* DMA */
     79 	bus_dma_tag_t	 sc_dmatag;
     80 	struct cs428x_dma *sc_dmas;
     81 	size_t dma_size;
     82 	size_t dma_align;
     83 
     84 	int     hw_blocksize;
     85 	int     type;
     86 
     87 	/* playback */
     88 	void	(*sc_pintr)(void *);	/* DMA completion intr handler */
     89 	void	*sc_parg;		/* arg for sc_intr() */
     90 	char	*sc_ps, *sc_pe, *sc_pn;
     91 	int	sc_pcount;
     92 	int	sc_pi;
     93 	struct	cs428x_dma *sc_pdma;
     94 	char	*sc_pbuf;
     95 	int     (*halt_output)__P((void *));
     96 	char	sc_prun;                /* playback status */
     97 	int     sc_prate;               /* playback sample rate */
     98 
     99 	/* capturing */
    100 	void	(*sc_rintr)(void *);	/* DMA completion intr handler */
    101 	void	*sc_rarg;		/* arg for sc_intr() */
    102 	char	*sc_rs, *sc_re, *sc_rn;
    103 	int	sc_rcount;
    104 	int	sc_ri;
    105 	struct	cs428x_dma *sc_rdma;
    106 	char	*sc_rbuf;
    107 	int	sc_rparam;		/* record format */
    108 	int     (*halt_input)__P((void *));
    109 	char	sc_rrun;                /* recording status */
    110 	int     sc_rrate;               /* recording sample rate */
    111 
    112 	/* Although cs4281 does not support midi (yet),
    113 	 * don't remove these definition.
    114 	 */
    115 	void	(*sc_iintr)(void *, int); /* midi input ready handler */
    116 	void	(*sc_ointr)(void *);	  /* midi output ready handler */
    117 	void	*sc_arg;
    118 
    119 	/*
    120 	 * XXX
    121 	 * Actually thease 2 variables are needed only for CS4280.
    122 	 */
    123 	u_int32_t pctl;
    124 	u_int32_t cctl;
    125 
    126 	/* AC97 CODEC */
    127 	struct ac97_codec_if *codec_if;
    128 	struct ac97_host_if host_if;
    129 
    130 	/* Power Management */
    131 	char	sc_suspend;
    132 	void   *sc_powerhook;		/* Power Hook */
    133 };
    134 
    135 
    136 int  cs428x_round_blocksize(void *, int, int, const audio_params_t *);
    137 int  cs428x_get_props(void *);
    138 int  cs428x_attach_codec(void *, struct ac97_codec_if *);
    139 int  cs428x_read_codec(void *, u_int8_t, u_int16_t *);
    140 int  cs428x_write_codec(void *, u_int8_t, u_int16_t);
    141 
    142 int  cs428x_mixer_set_port(void *, mixer_ctrl_t *);
    143 int  cs428x_mixer_get_port(void *, mixer_ctrl_t *);
    144 int  cs428x_query_devinfo(void *, mixer_devinfo_t *);
    145 void *cs428x_malloc(void *, int, size_t, struct malloc_type *, int);
    146 size_t cs428x_round_buffersize(void *, int, size_t);
    147 void cs428x_free(void *, void *, struct malloc_type *);
    148 paddr_t cs428x_mappage(void *, void *, off_t, int);
    149 
    150 /* internal functions */
    151 int cs428x_allocmem(struct cs428x_softc *, size_t, struct malloc_type *,
    152 	int, struct cs428x_dma *);
    153 int cs428x_src_wait(struct cs428x_softc *);
    154 
    155 
    156 /* DEBUG */
    157 /* #define CS4280_DEBUG */
    158 /* #define CS4281_DEBUG */
    159 
    160 #if defined(CS4280_DEBUG) || defined(CS4281_DEBUG)
    161 #define DPRINTF(x)	    if (cs428x_debug) printf x
    162 #define DPRINTFN(n,x)	    if (cs428x_debug>(n)) printf x
    163 extern int cs428x_debug;
    164 #if CS4280_DEBUG + 0 == 0
    165 #undef CS4280_DEBUG
    166 #define CS4280_DEBUG 0
    167 #endif
    168 #else
    169 #define DPRINTF(x)
    170 #define DPRINTFN(n,x)
    171 #endif
    172 
    173 #endif /* _CS428X_H_ */
    174