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