LXR linux/sound/pci/ctxfi/ctresource.h

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