mirror of
https://github.com/torvalds/linux.git
synced 2024-11-23 20:51:44 +00:00
a08b9f2f22
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. There are files in sound/pci/ctxfi which follow this syntax in their file headers, i.e. start with '/**' like comments, which causes unexpected warnings from kernel-doc. E.g., running scripts/kernel-doc -none on sound/pci/ctxfi/ctresource.c causes this warning: "warning: wrong kernel-doc identifier on line: * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved." Similarly for other files too. Provide a simple fix by replacing the kernel-doc like comment syntax with general format, i.e. "/*", to prevent kernel-doc from parsing it. Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20210317203932.23993-1-yashsri421@gmail.com Signed-off-by: Takashi Iwai <tiwai@suse.de>
70 lines
2.1 KiB
C
70 lines
2.1 KiB
C
/* SPDX-License-Identifier: GPL-2.0-only */
|
|
/*
|
|
* Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
|
|
*
|
|
* @File ctresource.h
|
|
*
|
|
* @Brief
|
|
* This file contains the definition of generic hardware resources for
|
|
* resource management.
|
|
*
|
|
* @Author Liu Chun
|
|
* @Date May 13 2008
|
|
*/
|
|
|
|
#ifndef CTRESOURCE_H
|
|
#define CTRESOURCE_H
|
|
|
|
#include <linux/types.h>
|
|
|
|
enum RSCTYP {
|
|
SRC,
|
|
SRCIMP,
|
|
AMIXER,
|
|
SUM,
|
|
DAIO,
|
|
NUM_RSCTYP /* This must be the last one and less than 16 */
|
|
};
|
|
|
|
struct rsc_ops;
|
|
|
|
struct rsc {
|
|
u32 idx:12; /* The index of a resource */
|
|
u32 type:4; /* The type (RSCTYP) of a resource */
|
|
u32 conj:12; /* Current conjugate index */
|
|
u32 msr:4; /* The Master Sample Rate a resource working on */
|
|
void *ctrl_blk; /* Chip specific control info block for a resource */
|
|
struct hw *hw; /* Chip specific object for hardware access means */
|
|
const struct rsc_ops *ops; /* Generic resource operations */
|
|
};
|
|
|
|
struct rsc_ops {
|
|
int (*master)(struct rsc *rsc); /* Move to master resource */
|
|
int (*next_conj)(struct rsc *rsc); /* Move to next conjugate resource */
|
|
int (*index)(const struct rsc *rsc); /* Return the index of resource */
|
|
/* Return the output slot number */
|
|
int (*output_slot)(const struct rsc *rsc);
|
|
};
|
|
|
|
int
|
|
rsc_init(struct rsc *rsc, u32 idx, enum RSCTYP type, u32 msr, struct hw *hw);
|
|
int rsc_uninit(struct rsc *rsc);
|
|
|
|
struct rsc_mgr {
|
|
enum RSCTYP type; /* The type (RSCTYP) of resource to manage */
|
|
unsigned int amount; /* The total amount of a kind of resource */
|
|
unsigned int avail; /* The amount of currently available resources */
|
|
unsigned char *rscs; /* The bit-map for resource allocation */
|
|
void *ctrl_blk; /* Chip specific control info block */
|
|
struct hw *hw; /* Chip specific object for hardware access */
|
|
};
|
|
|
|
/* Resource management is based on bit-map mechanism */
|
|
int rsc_mgr_init(struct rsc_mgr *mgr, enum RSCTYP type,
|
|
unsigned int amount, struct hw *hw);
|
|
int rsc_mgr_uninit(struct rsc_mgr *mgr);
|
|
int mgr_get_resource(struct rsc_mgr *mgr, unsigned int n, unsigned int *ridx);
|
|
int mgr_put_resource(struct rsc_mgr *mgr, unsigned int n, unsigned int idx);
|
|
|
|
#endif /* CTRESOURCE_H */
|