04459aa0d4d90d315a8088fd045746e2b37cf4bd
[linux-2.6.git] / sound / pci / ctxfi / ctatc.h
1 /**
2  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
3  *
4  * This source file is released under GPL v2 license (no other versions).
5  * See the COPYING file included in the main directory of this source
6  * distribution for the license terms and conditions.
7  *
8  * @File        ctatc.h
9  *
10  * @Brief
11  * This file contains the definition of the device resource management object.
12  *
13  * @Author      Liu Chun
14  * @Date        Mar 28 2008
15  *
16  */
17
18 #ifndef CTATC_H
19 #define CTATC_H
20
21 #include <linux/types.h>
22 #include <linux/spinlock_types.h>
23 #include <linux/pci.h>
24 #include <linux/timer.h>
25 #include <sound/core.h>
26
27 #include "ctvmem.h"
28 #include "ctresource.h"
29
30 enum CTALSADEVS {               /* Types of alsa devices */
31         FRONT,
32         SURROUND,
33         CLFE,
34         SIDE,
35         IEC958,
36         MIXER,
37         NUM_CTALSADEVS          /* This should always be the last */
38 };
39
40 enum CTCARDS {
41         CTSB0760,
42         CTHENDRIX,
43         CTSB08801,
44         CTSB08802,
45         CTSB08803,
46         NUM_CTCARDS             /* This should always be the last */
47 };
48
49 struct ct_atc_chip_sub_details {
50         u16 subsys;
51         const char *nm_model;
52 };
53
54 struct ct_atc_chip_details {
55         u16 vendor;
56         u16 device;
57         const struct ct_atc_chip_sub_details *sub_details;
58         const char *nm_card;
59 };
60
61 struct ct_atc;
62 struct ct_timer;
63 struct ct_timer_instance;
64
65 /* alsa pcm stream descriptor */
66 struct ct_atc_pcm {
67         struct snd_pcm_substream *substream;
68         void (*interrupt)(struct ct_atc_pcm *apcm);
69         struct ct_timer_instance *timer;
70         unsigned int started:1;
71
72         /* Only mono and interleaved modes are supported now. */
73         struct ct_vm_block *vm_block;
74         void *src;              /* SRC for interacting with host memory */
75         void **srccs;           /* SRCs for sample rate conversion */
76         void **srcimps;         /* SRC Input Mappers */
77         void **amixers;         /* AMIXERs for routing converted data */
78         void *mono;             /* A SUM resource for mixing chs to one */
79         unsigned char n_srcc;   /* Number of converting SRCs */
80         unsigned char n_srcimp; /* Number of SRC Input Mappers */
81         unsigned char n_amixer; /* Number of AMIXERs */
82 };
83
84 /* Chip resource management object */
85 struct ct_atc {
86         struct pci_dev *pci;
87         struct snd_card *card;
88         unsigned int rsr; /* reference sample rate in Hz */
89         unsigned int msr; /* master sample rate in rsr */
90         unsigned int pll_rate; /* current rate of Phase Lock Loop */
91
92         const struct ct_atc_chip_details *chip_details;
93         enum CTCARDS model;
94
95         struct ct_vm *vm; /* device virtual memory manager for this card */
96         int (*map_audio_buffer)(struct ct_atc *atc, struct ct_atc_pcm *apcm);
97         void (*unmap_audio_buffer)(struct ct_atc *atc, struct ct_atc_pcm *apcm);
98         unsigned long (*get_ptp_phys)(struct ct_atc *atc, int index);
99
100         spinlock_t atc_lock;
101
102         int (*pcm_playback_prepare)(struct ct_atc *atc,
103                                     struct ct_atc_pcm *apcm);
104         int (*pcm_playback_start)(struct ct_atc *atc, struct ct_atc_pcm *apcm);
105         int (*pcm_playback_stop)(struct ct_atc *atc, struct ct_atc_pcm *apcm);
106         int (*pcm_playback_position)(struct ct_atc *atc,
107                                      struct ct_atc_pcm *apcm);
108         int (*spdif_passthru_playback_prepare)(struct ct_atc *atc,
109                                                struct ct_atc_pcm *apcm);
110         int (*pcm_capture_prepare)(struct ct_atc *atc, struct ct_atc_pcm *apcm);
111         int (*pcm_capture_start)(struct ct_atc *atc, struct ct_atc_pcm *apcm);
112         int (*pcm_capture_stop)(struct ct_atc *atc, struct ct_atc_pcm *apcm);
113         int (*pcm_capture_position)(struct ct_atc *atc,
114                                     struct ct_atc_pcm *apcm);
115         int (*pcm_release_resources)(struct ct_atc *atc,
116                                      struct ct_atc_pcm *apcm);
117         int (*select_line_in)(struct ct_atc *atc);
118         int (*select_mic_in)(struct ct_atc *atc);
119         int (*select_digit_io)(struct ct_atc *atc);
120         int (*line_front_unmute)(struct ct_atc *atc, unsigned char state);
121         int (*line_surround_unmute)(struct ct_atc *atc, unsigned char state);
122         int (*line_clfe_unmute)(struct ct_atc *atc, unsigned char state);
123         int (*line_rear_unmute)(struct ct_atc *atc, unsigned char state);
124         int (*line_in_unmute)(struct ct_atc *atc, unsigned char state);
125         int (*spdif_out_unmute)(struct ct_atc *atc, unsigned char state);
126         int (*spdif_in_unmute)(struct ct_atc *atc, unsigned char state);
127         int (*spdif_out_get_status)(struct ct_atc *atc, unsigned int *status);
128         int (*spdif_out_set_status)(struct ct_atc *atc, unsigned int status);
129         int (*spdif_out_passthru)(struct ct_atc *atc, unsigned char state);
130         int (*have_digit_io_switch)(struct ct_atc *atc);
131
132         /* Don't touch! Used for internal object. */
133         void *rsc_mgrs[NUM_RSCTYP]; /* chip resource managers */
134         void *mixer;            /* internal mixer object */
135         void *hw;               /* chip specific hardware access object */
136         void **daios;           /* digital audio io resources */
137         void **pcm;             /* SUMs for collecting all pcm stream */
138         void **srcs;            /* Sample Rate Converters for input signal */
139         void **srcimps;         /* input mappers for SRCs */
140         unsigned char n_daio;
141         unsigned char n_src;
142         unsigned char n_srcimp;
143         unsigned char n_pcm;
144
145         struct ct_timer *timer;
146 };
147
148
149 int __devinit ct_atc_create(struct snd_card *card, struct pci_dev *pci,
150                             unsigned int rsr, unsigned int msr,
151                             struct ct_atc **ratc);
152 int __devinit ct_atc_create_alsa_devs(struct ct_atc *atc);
153
154 #endif /* CTATC_H */