[mirror_ubuntu-jammy-kernel.git] / sound / pci / ctxfi / cthardware.h

/* SPDX-License-Identifier: GPL-2.0-only */
/**
 * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
 *
 * @File	cthardware.h
 *
 * @Brief
 * This file contains the definition of hardware access methord.
 *
 * @Author	Liu Chun
 * @Date 	May 13 2008
 */

#ifndef CTHARDWARE_H
#define CTHARDWARE_H

#include <linux/types.h>
#include <linux/pci.h>
#include <sound/core.h>

enum CHIPTYP {
	ATC20K1,
	ATC20K2,
	ATCNONE
};

enum CTCARDS {
	/* 20k1 models */
	CTSB055X,
	CT20K1_MODEL_FIRST = CTSB055X,
	CTSB073X,
	CTUAA,
	CT20K1_UNKNOWN,
	/* 20k2 models */
	CTSB0760,
	CT20K2_MODEL_FIRST = CTSB0760,
	CTHENDRIX,
	CTSB0880,
	CTSB1270,
	CT20K2_UNKNOWN,
	NUM_CTCARDS		/* This should always be the last */
};

/* Type of input source for ADC */
enum ADCSRC{
	ADC_MICIN,
	ADC_LINEIN,
	ADC_VIDEO,
	ADC_AUX,
	ADC_NONE	/* Switch to digital input */
};

struct card_conf {
	/* device virtual mem page table page physical addr
	 * (supporting one page table page now) */
	unsigned long vm_pgt_phys;
	unsigned int rsr;	/* reference sample rate in Hzs*/
	unsigned int msr;	/* master sample rate in rsrs */
};

struct capabilities {
	unsigned int digit_io_switch:1;
	unsigned int dedicated_mic:1;
	unsigned int output_switch:1;
	unsigned int mic_source_switch:1;
};

struct hw {
	int (*card_init)(struct hw *hw, struct card_conf *info);
	int (*card_stop)(struct hw *hw);
	int (*pll_init)(struct hw *hw, unsigned int rsr);
#ifdef CONFIG_PM_SLEEP
	int (*suspend)(struct hw *hw);
	int (*resume)(struct hw *hw, struct card_conf *info);
#endif
	int (*is_adc_source_selected)(struct hw *hw, enum ADCSRC source);
	int (*select_adc_source)(struct hw *hw, enum ADCSRC source);
	struct capabilities (*capabilities)(struct hw *hw);
	int (*output_switch_get)(struct hw *hw);
	int (*output_switch_put)(struct hw *hw, int position);
	int (*mic_source_switch_get)(struct hw *hw);
	int (*mic_source_switch_put)(struct hw *hw, int position);

	/* SRC operations */
	int (*src_rsc_get_ctrl_blk)(void **rblk);
	int (*src_rsc_put_ctrl_blk)(void *blk);
	int (*src_set_state)(void *blk, unsigned int state);
	int (*src_set_bm)(void *blk, unsigned int bm);
	int (*src_set_rsr)(void *blk, unsigned int rsr);
	int (*src_set_sf)(void *blk, unsigned int sf);
	int (*src_set_wr)(void *blk, unsigned int wr);
	int (*src_set_pm)(void *blk, unsigned int pm);
	int (*src_set_rom)(void *blk, unsigned int rom);
	int (*src_set_vo)(void *blk, unsigned int vo);
	int (*src_set_st)(void *blk, unsigned int st);
	int (*src_set_ie)(void *blk, unsigned int ie);
	int (*src_set_ilsz)(void *blk, unsigned int ilsz);
	int (*src_set_bp)(void *blk, unsigned int bp);
	int (*src_set_cisz)(void *blk, unsigned int cisz);
	int (*src_set_ca)(void *blk, unsigned int ca);
	int (*src_set_sa)(void *blk, unsigned int sa);
	int (*src_set_la)(void *blk, unsigned int la);
	int (*src_set_pitch)(void *blk, unsigned int pitch);
	int (*src_set_clear_zbufs)(void *blk, unsigned int clear);
	int (*src_set_dirty)(void *blk, unsigned int flags);
	int (*src_set_dirty_all)(void *blk);
	int (*src_commit_write)(struct hw *hw, unsigned int idx, void *blk);
	int (*src_get_ca)(struct hw *hw, unsigned int idx, void *blk);
	unsigned int (*src_get_dirty)(void *blk);
	unsigned int (*src_dirty_conj_mask)(void);
	int (*src_mgr_get_ctrl_blk)(void **rblk);
	int (*src_mgr_put_ctrl_blk)(void *blk);
	/* syncly enable src @idx */
	int (*src_mgr_enbs_src)(void *blk, unsigned int idx);
	/* enable src @idx */
	int (*src_mgr_enb_src)(void *blk, unsigned int idx);
	/* disable src @idx */
	int (*src_mgr_dsb_src)(void *blk, unsigned int idx);
	int (*src_mgr_commit_write)(struct hw *hw, void *blk);

	/* SRC Input Mapper operations */
	int (*srcimp_mgr_get_ctrl_blk)(void **rblk);
	int (*srcimp_mgr_put_ctrl_blk)(void *blk);
	int (*srcimp_mgr_set_imaparc)(void *blk, unsigned int slot);
	int (*srcimp_mgr_set_imapuser)(void *blk, unsigned int user);
	int (*srcimp_mgr_set_imapnxt)(void *blk, unsigned int next);
	int (*srcimp_mgr_set_imapaddr)(void *blk, unsigned int addr);
	int (*srcimp_mgr_commit_write)(struct hw *hw, void *blk);

	/* AMIXER operations */
	int (*amixer_rsc_get_ctrl_blk)(void **rblk);
	int (*amixer_rsc_put_ctrl_blk)(void *blk);
	int (*amixer_mgr_get_ctrl_blk)(void **rblk);
	int (*amixer_mgr_put_ctrl_blk)(void *blk);
	int (*amixer_set_mode)(void *blk, unsigned int mode);
	int (*amixer_set_iv)(void *blk, unsigned int iv);
	int (*amixer_set_x)(void *blk, unsigned int x);
	int (*amixer_set_y)(void *blk, unsigned int y);
	int (*amixer_set_sadr)(void *blk, unsigned int sadr);
	int (*amixer_set_se)(void *blk, unsigned int se);
	int (*amixer_set_dirty)(void *blk, unsigned int flags);
	int (*amixer_set_dirty_all)(void *blk);
	int (*amixer_commit_write)(struct hw *hw, unsigned int idx, void *blk);
	int (*amixer_get_y)(void *blk);
	unsigned int (*amixer_get_dirty)(void *blk);

	/* DAIO operations */
	int (*dai_get_ctrl_blk)(void **rblk);
	int (*dai_put_ctrl_blk)(void *blk);
	int (*dai_srt_set_srco)(void *blk, unsigned int src);
	int (*dai_srt_set_srcm)(void *blk, unsigned int src);
	int (*dai_srt_set_rsr)(void *blk, unsigned int rsr);
	int (*dai_srt_set_drat)(void *blk, unsigned int drat);
	int (*dai_srt_set_ec)(void *blk, unsigned int ec);
	int (*dai_srt_set_et)(void *blk, unsigned int et);
	int (*dai_commit_write)(struct hw *hw, unsigned int idx, void *blk);
	int (*dao_get_ctrl_blk)(void **rblk);
	int (*dao_put_ctrl_blk)(void *blk);
	int (*dao_set_spos)(void *blk, unsigned int spos);
	int (*dao_commit_write)(struct hw *hw, unsigned int idx, void *blk);
	int (*dao_get_spos)(void *blk, unsigned int *spos);

	int (*daio_mgr_get_ctrl_blk)(struct hw *hw, void **rblk);
	int (*daio_mgr_put_ctrl_blk)(void *blk);
	int (*daio_mgr_enb_dai)(void *blk, unsigned int idx);
	int (*daio_mgr_dsb_dai)(void *blk, unsigned int idx);
	int (*daio_mgr_enb_dao)(void *blk, unsigned int idx);
	int (*daio_mgr_dsb_dao)(void *blk, unsigned int idx);
	int (*daio_mgr_dao_init)(void *blk, unsigned int idx,
						unsigned int conf);
	int (*daio_mgr_set_imaparc)(void *blk, unsigned int slot);
	int (*daio_mgr_set_imapnxt)(void *blk, unsigned int next);
	int (*daio_mgr_set_imapaddr)(void *blk, unsigned int addr);
	int (*daio_mgr_commit_write)(struct hw *hw, void *blk);

	int (*set_timer_irq)(struct hw *hw, int enable);
	int (*set_timer_tick)(struct hw *hw, unsigned int tick);
	unsigned int (*get_wc)(struct hw *hw);

	void (*irq_callback)(void *data, unsigned int bit);
	void *irq_callback_data;

	struct pci_dev *pci;	/* the pci kernel structure of this card */
	struct snd_card *card;	/* pointer to this card */
	int irq;
	unsigned long io_base;
	void __iomem *mem_base;

	enum CHIPTYP chip_type;
	enum CTCARDS model;
};

int create_hw_obj(struct pci_dev *pci, enum CHIPTYP chip_type,
		  enum CTCARDS model, struct hw **rhw);
int destroy_hw_obj(struct hw *hw);

unsigned int get_field(unsigned int data, unsigned int field);
void set_field(unsigned int *data, unsigned int field, unsigned int value);

/* IRQ bits */
#define	PLL_INT		(1 << 10) /* PLL input-clock out-of-range */
#define FI_INT		(1 << 9)  /* forced interrupt */
#define IT_INT		(1 << 8)  /* timer interrupt */
#define PCI_INT		(1 << 7)  /* PCI bus error pending */
#define URT_INT		(1 << 6)  /* UART Tx/Rx */
#define GPI_INT		(1 << 5)  /* GPI pin */
#define MIX_INT		(1 << 4)  /* mixer parameter segment FIFO channels */
#define DAI_INT		(1 << 3)  /* DAI (SR-tracker or SPDIF-receiver) */
#define TP_INT		(1 << 2)  /* transport priority queue */
#define DSP_INT		(1 << 1)  /* DSP */
#define SRC_INT		(1 << 0)  /* SRC channels */

#endif /* CTHARDWARE_H */
Commit	Line	Data
5765e78e	1	/* SPDX-License-Identifier: GPL-2.0-only */
8cc72361 WYC	2	/**
	3	* Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
	4	*
8cc72361 WYC	5	* @File cthardware.h
	6	*
	7	* @Brief
	8	* This file contains the definition of hardware access methord.
	9	*
	10	* @Author Liu Chun
	11	* @Date May 13 2008
8cc72361 WYC	12	*/
	13
	14	#ifndef CTHARDWARE_H
	15	#define CTHARDWARE_H
	16
	17	#include <linux/types.h>
	18	#include <linux/pci.h>
3d0fdc86	19	#include <sound/core.h>
8cc72361 WYC	20
	21	enum CHIPTYP {
	22	ATC20K1,
	23	ATC20K2,
	24	ATCNONE
	25	};
	26
9470195a TI	27	enum CTCARDS {
	28	/* 20k1 models */
	29	CTSB055X,
a8f4310b	30	CT20K1_MODEL_FIRST = CTSB055X,
9470195a TI	31	CTSB073X,
	32	CTUAA,
	33	CT20K1_UNKNOWN,
	34	/* 20k2 models */
	35	CTSB0760,
a8f4310b	36	CT20K2_MODEL_FIRST = CTSB0760,
9470195a TI	37	CTHENDRIX,
9470195a TI	38	CTSB0880,
55309216	39	CTSB1270,
a8f4310b	40	CT20K2_UNKNOWN,
9470195a TI	41	NUM_CTCARDS /* This should always be the last */
	42	};
	43
8cc72361 WYC	44	/* Type of input source for ADC */
	45	enum ADCSRC{
	46	ADC_MICIN,
	47	ADC_LINEIN,
	48	ADC_VIDEO,
	49	ADC_AUX,
	50	ADC_NONE /* Switch to digital input */
	51	};
	52
	53	struct card_conf {
	54	/* device virtual mem page table page physical addr
	55	* (supporting one page table page now) */
	56	unsigned long vm_pgt_phys;
	57	unsigned int rsr; /* reference sample rate in Hzs*/
	58	unsigned int msr; /* master sample rate in rsrs */
	59	};
	60
b028b818 HB	61	struct capabilities {
	62	unsigned int digit_io_switch:1;
	63	unsigned int dedicated_mic:1;
	64	unsigned int output_switch:1;
	65	unsigned int mic_source_switch:1;
	66	};
	67
8cc72361 WYC	68	struct hw {
	69	int (card_init)(struct hw hw, struct card_conf *info);
	70	int (card_stop)(struct hw hw);
	71	int (pll_init)(struct hw hw, unsigned int rsr);
c7561cd8	72	#ifdef CONFIG_PM_SLEEP
68cb2b55	73	int (suspend)(struct hw hw);
29959a09 WYC	74	int (resume)(struct hw hw, struct card_conf *info);
29959a09 WYC	75	#endif
8cc72361 WYC	76	int (is_adc_source_selected)(struct hw hw, enum ADCSRC source);
8cc72361 WYC	77	int (select_adc_source)(struct hw hw, enum ADCSRC source);
b028b818	78	struct capabilities (capabilities)(struct hw hw);
55309216 HB	79	int (output_switch_get)(struct hw hw);
55309216 HB	80	int (output_switch_put)(struct hw hw, int position);
55309216 HB	81	int (mic_source_switch_get)(struct hw hw);
55309216 HB	82	int (mic_source_switch_put)(struct hw hw, int position);
8cc72361 WYC	83
	84	/* SRC operations */
	85	int (src_rsc_get_ctrl_blk)(void *rblk);
	86	int (src_rsc_put_ctrl_blk)(void blk);
	87	int (src_set_state)(void blk, unsigned int state);
	88	int (src_set_bm)(void blk, unsigned int bm);
	89	int (src_set_rsr)(void blk, unsigned int rsr);
	90	int (src_set_sf)(void blk, unsigned int sf);
	91	int (src_set_wr)(void blk, unsigned int wr);
	92	int (src_set_pm)(void blk, unsigned int pm);
	93	int (src_set_rom)(void blk, unsigned int rom);
	94	int (src_set_vo)(void blk, unsigned int vo);
	95	int (src_set_st)(void blk, unsigned int st);
	96	int (src_set_ie)(void blk, unsigned int ie);
	97	int (src_set_ilsz)(void blk, unsigned int ilsz);
	98	int (src_set_bp)(void blk, unsigned int bp);
	99	int (src_set_cisz)(void blk, unsigned int cisz);
	100	int (src_set_ca)(void blk, unsigned int ca);
	101	int (src_set_sa)(void blk, unsigned int sa);
	102	int (src_set_la)(void blk, unsigned int la);
	103	int (src_set_pitch)(void blk, unsigned int pitch);
	104	int (src_set_clear_zbufs)(void blk, unsigned int clear);
	105	int (src_set_dirty)(void blk, unsigned int flags);
	106	int (src_set_dirty_all)(void blk);
	107	int (src_commit_write)(struct hw hw, unsigned int idx, void *blk);
	108	int (src_get_ca)(struct hw hw, unsigned int idx, void *blk);
	109	unsigned int (src_get_dirty)(void blk);
	110	unsigned int (*src_dirty_conj_mask)(void);
	111	int (src_mgr_get_ctrl_blk)(void *rblk);
	112	int (src_mgr_put_ctrl_blk)(void blk);
	113	/* syncly enable src @idx */
	114	int (src_mgr_enbs_src)(void blk, unsigned int idx);
	115	/* enable src @idx */
	116	int (src_mgr_enb_src)(void blk, unsigned int idx);
	117	/* disable src @idx */
	118	int (src_mgr_dsb_src)(void blk, unsigned int idx);
	119	int (src_mgr_commit_write)(struct hw hw, void *blk);
	120
	121	/* SRC Input Mapper operations */
	122	int (srcimp_mgr_get_ctrl_blk)(void *rblk);
	123	int (srcimp_mgr_put_ctrl_blk)(void blk);
	124	int (srcimp_mgr_set_imaparc)(void blk, unsigned int slot);
	125	int (srcimp_mgr_set_imapuser)(void blk, unsigned int user);
	126	int (srcimp_mgr_set_imapnxt)(void blk, unsigned int next);
	127	int (srcimp_mgr_set_imapaddr)(void blk, unsigned int addr);
	128	int (srcimp_mgr_commit_write)(struct hw hw, void *blk);
	129
	130	/* AMIXER operations */
	131	int (amixer_rsc_get_ctrl_blk)(void *rblk);
	132	int (amixer_rsc_put_ctrl_blk)(void blk);
	133	int (amixer_mgr_get_ctrl_blk)(void *rblk);
	134	int (amixer_mgr_put_ctrl_blk)(void blk);
	135	int (amixer_set_mode)(void blk, unsigned int mode);
	136	int (amixer_set_iv)(void blk, unsigned int iv);
	137	int (amixer_set_x)(void blk, unsigned int x);
	138	int (amixer_set_y)(void blk, unsigned int y);
	139	int (amixer_set_sadr)(void blk, unsigned int sadr);
	140	int (amixer_set_se)(void blk, unsigned int se);
	141	int (amixer_set_dirty)(void blk, unsigned int flags);
	142	int (amixer_set_dirty_all)(void blk);
	143	int (amixer_commit_write)(struct hw hw, unsigned int idx, void *blk);
	144	int (amixer_get_y)(void blk);
	145	unsigned int (amixer_get_dirty)(void blk);
	146
147	/* DAIO operations */
148	int (dai_get_ctrl_blk)(void *rblk);
149	int (dai_put_ctrl_blk)(void blk);
150	int (dai_srt_set_srco)(void blk, unsigned int src);
151	int (dai_srt_set_srcm)(void blk, unsigned int src);
152	int (dai_srt_set_rsr)(void blk, unsigned int rsr);
153	int (dai_srt_set_drat)(void blk, unsigned int drat);
154	int (dai_srt_set_ec)(void blk, unsigned int ec);
155	int (dai_srt_set_et)(void blk, unsigned int et);
156	int (dai_commit_write)(struct hw hw, unsigned int idx, void *blk);
157	int (dao_get_ctrl_blk)(void *rblk);
158	int (dao_put_ctrl_blk)(void blk);
159	int (dao_set_spos)(void blk, unsigned int spos);
160	int (dao_commit_write)(struct hw hw, unsigned int idx, void *blk);
161	int (dao_get_spos)(void blk, unsigned int *spos);
162
163	int (daio_mgr_get_ctrl_blk)(struct hw hw, void **rblk);
164	int (daio_mgr_put_ctrl_blk)(void blk);
165	int (daio_mgr_enb_dai)(void blk, unsigned int idx);
166	int (daio_mgr_dsb_dai)(void blk, unsigned int idx);
167	int (daio_mgr_enb_dao)(void blk, unsigned int idx);
168	int (daio_mgr_dsb_dao)(void blk, unsigned int idx);
169	int (daio_mgr_dao_init)(void blk, unsigned int idx,
170	unsigned int conf);
171	int (daio_mgr_set_imaparc)(void blk, unsigned int slot);
172	int (daio_mgr_set_imapnxt)(void blk, unsigned int next);
173	int (daio_mgr_set_imapaddr)(void blk, unsigned int addr);
174	int (daio_mgr_commit_write)(struct hw hw, void *blk);
175
b7bbf876 TI	176	int (set_timer_irq)(struct hw hw, int enable);
b7bbf876 TI	177	int (set_timer_tick)(struct hw hw, unsigned int tick);
54de6bc8	178	unsigned int (get_wc)(struct hw hw);
b7bbf876 TI	179
	180	void (irq_callback)(void data, unsigned int bit);
	181	void *irq_callback_data;
	182
8cc72361	183	struct pci_dev pci; / the pci kernel structure of this card */
3d0fdc86	184	struct snd_card card; / pointer to this card */
8cc72361 WYC	185	int irq;
8cc72361 WYC	186	unsigned long io_base;
7a7686bd	187	void __iomem *mem_base;
9470195a TI	188
	189	enum CHIPTYP chip_type;
	190	enum CTCARDS model;
8cc72361 WYC	191	};
8cc72361 WYC	192
9470195a TI	193	int create_hw_obj(struct pci_dev *pci, enum CHIPTYP chip_type,
9470195a TI	194	enum CTCARDS model, struct hw **rhw);
8cc72361 WYC	195	int destroy_hw_obj(struct hw *hw);
	196
	197	unsigned int get_field(unsigned int data, unsigned int field);
	198	void set_field(unsigned int *data, unsigned int field, unsigned int value);
	199
b7bbf876 TI	200	/* IRQ bits */
	201	#define PLL_INT (1 << 10) /* PLL input-clock out-of-range */
	202	#define FI_INT (1 << 9) /* forced interrupt */
	203	#define IT_INT (1 << 8) /* timer interrupt */
	204	#define PCI_INT (1 << 7) /* PCI bus error pending */
	205	#define URT_INT (1 << 6) /* UART Tx/Rx */
	206	#define GPI_INT (1 << 5) /* GPI pin */
	207	#define MIX_INT (1 << 4) /* mixer parameter segment FIFO channels */
	208	#define DAI_INT (1 << 3) /* DAI (SR-tracker or SPDIF-receiver) */
	209	#define TP_INT (1 << 2) /* transport priority queue */
	210	#define DSP_INT (1 << 1) /* DSP */
	211	#define SRC_INT (1 << 0) /* SRC channels */
	212
8cc72361	213	#endif /* CTHARDWARE_H */