162306a36Sopenharmony_ci/* SPDX-License-Identifier: GPL-2.0-only */
262306a36Sopenharmony_ci/*
362306a36Sopenharmony_ci * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
462306a36Sopenharmony_ci *
562306a36Sopenharmony_ci * @File	ctresource.h
662306a36Sopenharmony_ci *
762306a36Sopenharmony_ci * @Brief
862306a36Sopenharmony_ci * This file contains the definition of generic hardware resources for
962306a36Sopenharmony_ci * resource management.
1062306a36Sopenharmony_ci *
1162306a36Sopenharmony_ci * @Author	Liu Chun
1262306a36Sopenharmony_ci * @Date 	May 13 2008
1362306a36Sopenharmony_ci */
1462306a36Sopenharmony_ci
1562306a36Sopenharmony_ci#ifndef CTRESOURCE_H
1662306a36Sopenharmony_ci#define CTRESOURCE_H
1762306a36Sopenharmony_ci
1862306a36Sopenharmony_ci#include <linux/types.h>
1962306a36Sopenharmony_ci
2062306a36Sopenharmony_cienum RSCTYP {
2162306a36Sopenharmony_ci	SRC,
2262306a36Sopenharmony_ci	SRCIMP,
2362306a36Sopenharmony_ci	AMIXER,
2462306a36Sopenharmony_ci	SUM,
2562306a36Sopenharmony_ci	DAIO,
2662306a36Sopenharmony_ci	NUM_RSCTYP	/* This must be the last one and less than 16 */
2762306a36Sopenharmony_ci};
2862306a36Sopenharmony_ci
2962306a36Sopenharmony_cistruct rsc_ops;
3062306a36Sopenharmony_ci
3162306a36Sopenharmony_cistruct rsc {
3262306a36Sopenharmony_ci	u32 idx:12;	/* The index of a resource */
3362306a36Sopenharmony_ci	u32 type:4;	/* The type (RSCTYP) of a resource */
3462306a36Sopenharmony_ci	u32 conj:12;	/* Current conjugate index */
3562306a36Sopenharmony_ci	u32 msr:4;	/* The Master Sample Rate a resource working on */
3662306a36Sopenharmony_ci	void *ctrl_blk;	/* Chip specific control info block for a resource */
3762306a36Sopenharmony_ci	struct hw *hw;	/* Chip specific object for hardware access means */
3862306a36Sopenharmony_ci	const struct rsc_ops *ops;	/* Generic resource operations */
3962306a36Sopenharmony_ci};
4062306a36Sopenharmony_ci
4162306a36Sopenharmony_cistruct rsc_ops {
4262306a36Sopenharmony_ci	void (*master)(struct rsc *rsc); /* Move to master resource */
4362306a36Sopenharmony_ci	void (*next_conj)(struct rsc *rsc); /* Move to next conjugate resource */
4462306a36Sopenharmony_ci	int (*index)(const struct rsc *rsc); /* Return the index of resource */
4562306a36Sopenharmony_ci	/* Return the output slot number */
4662306a36Sopenharmony_ci	int (*output_slot)(const struct rsc *rsc);
4762306a36Sopenharmony_ci};
4862306a36Sopenharmony_ci
4962306a36Sopenharmony_ciint
5062306a36Sopenharmony_cirsc_init(struct rsc *rsc, u32 idx, enum RSCTYP type, u32 msr, struct hw *hw);
5162306a36Sopenharmony_ciint rsc_uninit(struct rsc *rsc);
5262306a36Sopenharmony_ci
5362306a36Sopenharmony_cistruct rsc_mgr {
5462306a36Sopenharmony_ci	enum RSCTYP type; /* The type (RSCTYP) of resource to manage */
5562306a36Sopenharmony_ci	unsigned int amount; /* The total amount of a kind of resource */
5662306a36Sopenharmony_ci	unsigned int avail; /* The amount of currently available resources */
5762306a36Sopenharmony_ci	unsigned char *rscs; /* The bit-map for resource allocation */
5862306a36Sopenharmony_ci	void *ctrl_blk; /* Chip specific control info block */
5962306a36Sopenharmony_ci	struct hw *hw; /* Chip specific object for hardware access */
6062306a36Sopenharmony_ci};
6162306a36Sopenharmony_ci
6262306a36Sopenharmony_ci/* Resource management is based on bit-map mechanism */
6362306a36Sopenharmony_ciint rsc_mgr_init(struct rsc_mgr *mgr, enum RSCTYP type,
6462306a36Sopenharmony_ci		 unsigned int amount, struct hw *hw);
6562306a36Sopenharmony_ciint rsc_mgr_uninit(struct rsc_mgr *mgr);
6662306a36Sopenharmony_ciint mgr_get_resource(struct rsc_mgr *mgr, unsigned int n, unsigned int *ridx);
6762306a36Sopenharmony_ciint mgr_put_resource(struct rsc_mgr *mgr, unsigned int n, unsigned int idx);
6862306a36Sopenharmony_ci
6962306a36Sopenharmony_ci#endif /* CTRESOURCE_H */
70