1 /* SPDX-License-Identifier: GPL-2.0-only */ !! 1 /**
2 /* <<
3 * Copyright (C) 2008, Creative Technology Ltd 2 * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
4 * 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 *
5 * @File ctresource.h 8 * @File ctresource.h
6 * 9 *
7 * @Brief 10 * @Brief
8 * This file contains the definition of generi 11 * This file contains the definition of generic hardware resources for
9 * resource management. 12 * resource management.
10 * 13 *
11 * @Author Liu Chun 14 * @Author Liu Chun
12 * @Date May 13 2008 15 * @Date May 13 2008
>> 16 *
13 */ 17 */
14 18
15 #ifndef CTRESOURCE_H 19 #ifndef CTRESOURCE_H
16 #define CTRESOURCE_H 20 #define CTRESOURCE_H
17 21
18 #include <linux/types.h> 22 #include <linux/types.h>
19 23
20 enum RSCTYP { 24 enum RSCTYP {
21 SRC, 25 SRC,
22 SRCIMP, 26 SRCIMP,
23 AMIXER, 27 AMIXER,
24 SUM, 28 SUM,
25 DAIO, 29 DAIO,
26 NUM_RSCTYP /* This must be the la 30 NUM_RSCTYP /* This must be the last one and less than 16 */
27 }; 31 };
28 32
29 struct rsc_ops; 33 struct rsc_ops;
30 34
31 struct rsc { 35 struct rsc {
32 u32 idx:12; /* The index of a reso 36 u32 idx:12; /* The index of a resource */
33 u32 type:4; /* The type (RSCTYP) o 37 u32 type:4; /* The type (RSCTYP) of a resource */
34 u32 conj:12; /* Current conjugate i 38 u32 conj:12; /* Current conjugate index */
35 u32 msr:4; /* The Master Sample R 39 u32 msr:4; /* The Master Sample Rate a resource working on */
36 void *ctrl_blk; /* Chip specific contr 40 void *ctrl_blk; /* Chip specific control info block for a resource */
37 struct hw *hw; /* Chip specific objec 41 struct hw *hw; /* Chip specific object for hardware access means */
38 const struct rsc_ops *ops; /* Gen 42 const struct rsc_ops *ops; /* Generic resource operations */
39 }; 43 };
40 44
41 struct rsc_ops { 45 struct rsc_ops {
42 void (*master)(struct rsc *rsc); /* Mo !! 46 int (*master)(struct rsc *rsc); /* Move to master resource */
43 void (*next_conj)(struct rsc *rsc); /* !! 47 int (*next_conj)(struct rsc *rsc); /* Move to next conjugate resource */
44 int (*index)(const struct rsc *rsc); / 48 int (*index)(const struct rsc *rsc); /* Return the index of resource */
45 /* Return the output slot number */ 49 /* Return the output slot number */
46 int (*output_slot)(const struct rsc *r 50 int (*output_slot)(const struct rsc *rsc);
47 }; 51 };
48 52
49 int 53 int
50 rsc_init(struct rsc *rsc, u32 idx, enum RSCTYP 54 rsc_init(struct rsc *rsc, u32 idx, enum RSCTYP type, u32 msr, struct hw *hw);
51 int rsc_uninit(struct rsc *rsc); 55 int rsc_uninit(struct rsc *rsc);
52 56
53 struct rsc_mgr { 57 struct rsc_mgr {
54 enum RSCTYP type; /* The type (RSCTYP) 58 enum RSCTYP type; /* The type (RSCTYP) of resource to manage */
55 unsigned int amount; /* The total amou 59 unsigned int amount; /* The total amount of a kind of resource */
56 unsigned int avail; /* The amount of c 60 unsigned int avail; /* The amount of currently available resources */
57 unsigned char *rscs; /* The bit-map fo 61 unsigned char *rscs; /* The bit-map for resource allocation */
58 void *ctrl_blk; /* Chip specific contr 62 void *ctrl_blk; /* Chip specific control info block */
59 struct hw *hw; /* Chip specific object 63 struct hw *hw; /* Chip specific object for hardware access */
60 }; 64 };
61 65
62 /* Resource management is based on bit-map mec 66 /* Resource management is based on bit-map mechanism */
63 int rsc_mgr_init(struct rsc_mgr *mgr, enum RSC 67 int rsc_mgr_init(struct rsc_mgr *mgr, enum RSCTYP type,
64 unsigned int amount, struct h 68 unsigned int amount, struct hw *hw);
65 int rsc_mgr_uninit(struct rsc_mgr *mgr); 69 int rsc_mgr_uninit(struct rsc_mgr *mgr);
66 int mgr_get_resource(struct rsc_mgr *mgr, unsi 70 int mgr_get_resource(struct rsc_mgr *mgr, unsigned int n, unsigned int *ridx);
67 int mgr_put_resource(struct rsc_mgr *mgr, unsi 71 int mgr_put_resource(struct rsc_mgr *mgr, unsigned int n, unsigned int idx);
68 72
69 #endif /* CTRESOURCE_H */ 73 #endif /* CTRESOURCE_H */
70 74
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.