xref: /OK3568_Linux_fs/kernel/sound/pci/ctxfi/ctsrc.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	ctsrc.h
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * @Brief
8*4882a593Smuzhiyun  * This file contains the definition of the Sample Rate Convertor
9*4882a593Smuzhiyun  * resource management object.
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * @Author	Liu Chun
12*4882a593Smuzhiyun  * @Date 	May 13 2008
13*4882a593Smuzhiyun  */
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #ifndef CTSRC_H
16*4882a593Smuzhiyun #define CTSRC_H
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #include "ctresource.h"
19*4882a593Smuzhiyun #include "ctimap.h"
20*4882a593Smuzhiyun #include <linux/spinlock.h>
21*4882a593Smuzhiyun #include <linux/list.h>
22*4882a593Smuzhiyun #include <sound/core.h>
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #define SRC_STATE_OFF	0x0
25*4882a593Smuzhiyun #define SRC_STATE_INIT	0x4
26*4882a593Smuzhiyun #define SRC_STATE_RUN	0x5
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #define SRC_SF_U8	0x0
29*4882a593Smuzhiyun #define SRC_SF_S16	0x1
30*4882a593Smuzhiyun #define SRC_SF_S24	0x2
31*4882a593Smuzhiyun #define SRC_SF_S32	0x3
32*4882a593Smuzhiyun #define SRC_SF_F32	0x4
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun /* Define the descriptor of a src resource */
35*4882a593Smuzhiyun enum SRCMODE {
36*4882a593Smuzhiyun 	MEMRD,		/* Read data from host memory */
37*4882a593Smuzhiyun 	MEMWR,		/* Write data to host memory */
38*4882a593Smuzhiyun 	ARCRW,		/* Read from and write to audio ring channel */
39*4882a593Smuzhiyun 	NUM_SRCMODES
40*4882a593Smuzhiyun };
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun struct src_rsc_ops;
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun struct src {
45*4882a593Smuzhiyun 	struct rsc rsc; /* Basic resource info */
46*4882a593Smuzhiyun 	struct src *intlv; /* Pointer to next interleaved SRC in a series */
47*4882a593Smuzhiyun 	const struct src_rsc_ops *ops; /* SRC specific operations */
48*4882a593Smuzhiyun 	/* Number of contiguous srcs for interleaved usage */
49*4882a593Smuzhiyun 	unsigned char multi;
50*4882a593Smuzhiyun 	unsigned char mode; /* Working mode of this SRC resource */
51*4882a593Smuzhiyun };
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun struct src_rsc_ops {
54*4882a593Smuzhiyun 	int (*set_state)(struct src *src, unsigned int state);
55*4882a593Smuzhiyun 	int (*set_bm)(struct src *src, unsigned int bm);
56*4882a593Smuzhiyun 	int (*set_sf)(struct src *src, unsigned int sf);
57*4882a593Smuzhiyun 	int (*set_pm)(struct src *src, unsigned int pm);
58*4882a593Smuzhiyun 	int (*set_rom)(struct src *src, unsigned int rom);
59*4882a593Smuzhiyun 	int (*set_vo)(struct src *src, unsigned int vo);
60*4882a593Smuzhiyun 	int (*set_st)(struct src *src, unsigned int st);
61*4882a593Smuzhiyun 	int (*set_bp)(struct src *src, unsigned int bp);
62*4882a593Smuzhiyun 	int (*set_cisz)(struct src *src, unsigned int cisz);
63*4882a593Smuzhiyun 	int (*set_ca)(struct src *src, unsigned int ca);
64*4882a593Smuzhiyun 	int (*set_sa)(struct src *src, unsigned int sa);
65*4882a593Smuzhiyun 	int (*set_la)(struct src *src, unsigned int la);
66*4882a593Smuzhiyun 	int (*set_pitch)(struct src *src, unsigned int pitch);
67*4882a593Smuzhiyun 	int (*set_clr_zbufs)(struct src *src);
68*4882a593Smuzhiyun 	int (*commit_write)(struct src *src);
69*4882a593Smuzhiyun 	int (*get_ca)(struct src *src);
70*4882a593Smuzhiyun 	int (*init)(struct src *src);
71*4882a593Smuzhiyun 	struct src* (*next_interleave)(struct src *src);
72*4882a593Smuzhiyun };
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun /* Define src resource request description info */
75*4882a593Smuzhiyun struct src_desc {
76*4882a593Smuzhiyun 	/* Number of contiguous master srcs for interleaved usage */
77*4882a593Smuzhiyun 	unsigned char multi;
78*4882a593Smuzhiyun 	unsigned char msr;
79*4882a593Smuzhiyun 	unsigned char mode; /* Working mode of the requested srcs */
80*4882a593Smuzhiyun };
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun /* Define src manager object */
83*4882a593Smuzhiyun struct src_mgr {
84*4882a593Smuzhiyun 	struct rsc_mgr mgr;	/* Basic resource manager info */
85*4882a593Smuzhiyun 	struct snd_card *card;	/* pointer to this card */
86*4882a593Smuzhiyun 	spinlock_t mgr_lock;
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 	 /* request src resource */
89*4882a593Smuzhiyun 	int (*get_src)(struct src_mgr *mgr,
90*4882a593Smuzhiyun 		       const struct src_desc *desc, struct src **rsrc);
91*4882a593Smuzhiyun 	/* return src resource */
92*4882a593Smuzhiyun 	int (*put_src)(struct src_mgr *mgr, struct src *src);
93*4882a593Smuzhiyun 	int (*src_enable_s)(struct src_mgr *mgr, struct src *src);
94*4882a593Smuzhiyun 	int (*src_enable)(struct src_mgr *mgr, struct src *src);
95*4882a593Smuzhiyun 	int (*src_disable)(struct src_mgr *mgr, struct src *src);
96*4882a593Smuzhiyun 	int (*commit_write)(struct src_mgr *mgr);
97*4882a593Smuzhiyun };
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun /* Define the descriptor of a SRC Input Mapper resource */
100*4882a593Smuzhiyun struct srcimp_mgr;
101*4882a593Smuzhiyun struct srcimp_rsc_ops;
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun struct srcimp {
104*4882a593Smuzhiyun 	struct rsc rsc;
105*4882a593Smuzhiyun 	unsigned char idx[8];
106*4882a593Smuzhiyun 	struct imapper *imappers;
107*4882a593Smuzhiyun 	unsigned int mapped; /* A bit-map indicating which conj rsc is mapped */
108*4882a593Smuzhiyun 	struct srcimp_mgr *mgr;
109*4882a593Smuzhiyun 	const struct srcimp_rsc_ops *ops;
110*4882a593Smuzhiyun };
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun struct srcimp_rsc_ops {
113*4882a593Smuzhiyun 	int (*map)(struct srcimp *srcimp, struct src *user, struct rsc *input);
114*4882a593Smuzhiyun 	int (*unmap)(struct srcimp *srcimp);
115*4882a593Smuzhiyun };
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun /* Define SRCIMP resource request description info */
118*4882a593Smuzhiyun struct srcimp_desc {
119*4882a593Smuzhiyun 	unsigned int msr;
120*4882a593Smuzhiyun };
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun struct srcimp_mgr {
123*4882a593Smuzhiyun 	struct rsc_mgr mgr;	/* Basic resource manager info */
124*4882a593Smuzhiyun 	struct snd_card *card;	/* pointer to this card */
125*4882a593Smuzhiyun 	spinlock_t mgr_lock;
126*4882a593Smuzhiyun 	spinlock_t imap_lock;
127*4882a593Smuzhiyun 	struct list_head imappers;
128*4882a593Smuzhiyun 	struct imapper *init_imap;
129*4882a593Smuzhiyun 	unsigned int init_imap_added;
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun 	 /* request srcimp resource */
132*4882a593Smuzhiyun 	int (*get_srcimp)(struct srcimp_mgr *mgr,
133*4882a593Smuzhiyun 			  const struct srcimp_desc *desc,
134*4882a593Smuzhiyun 			  struct srcimp **rsrcimp);
135*4882a593Smuzhiyun 	/* return srcimp resource */
136*4882a593Smuzhiyun 	int (*put_srcimp)(struct srcimp_mgr *mgr, struct srcimp *srcimp);
137*4882a593Smuzhiyun 	int (*imap_add)(struct srcimp_mgr *mgr, struct imapper *entry);
138*4882a593Smuzhiyun 	int (*imap_delete)(struct srcimp_mgr *mgr, struct imapper *entry);
139*4882a593Smuzhiyun };
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun /* Constructor and destructor of SRC resource manager */
142*4882a593Smuzhiyun int src_mgr_create(struct hw *hw, struct src_mgr **rsrc_mgr);
143*4882a593Smuzhiyun int src_mgr_destroy(struct src_mgr *src_mgr);
144*4882a593Smuzhiyun /* Constructor and destructor of SRCIMP resource manager */
145*4882a593Smuzhiyun int srcimp_mgr_create(struct hw *hw, struct srcimp_mgr **rsrc_mgr);
146*4882a593Smuzhiyun int srcimp_mgr_destroy(struct srcimp_mgr *srcimp_mgr);
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun #endif /* CTSRC_H */
149