drivers/staging/tidspbridge/include/dspbridge/cfg.h

   1 /*
   2  * cfg.h
   3  *
   4  * DSP-BIOS Bridge driver support functions for TI OMAP processors.
   5  *
   6  * PM Configuration module.
   7  *
   8  * Copyright (C) 2005-2006 Texas Instruments, Inc.
   9  *
  10  * This package is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  16  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  17  */
  18
  19 #ifndef CFG_
  20 #define CFG_
  21 #include <dspbridge/host_os.h>
  22 #include <dspbridge/cfgdefs.h>
  23
  24 /*
  25  *  ======== cfg_get_cd_version ========
  26  *  Purpose:
  27  *      Retrieves the version of the PM Class Driver.
  28  *  Parameters:
  29  *      version:    Ptr to u32 to contain version number upon return.
  30  *  Returns:
  31  *      0:    Success.  version contains Class Driver version in
  32  *                  the form: 0xAABBCCDD where AABB is Major version and
  33  *                  CCDD is Minor.
  34  *      -EPERM:  Failure.
  35  *  Requires:
  36  *      CFG initialized.
  37  *  Ensures:
  38  *      0:    Success.
  39  *      else:       *version is NULL.
  40  */
  41 extern int cfg_get_cd_version(u32 *version);
  42
  43 /*
  44  *  ======== cfg_get_perf_value ========
  45  *  Purpose:
  46  *      Retrieve a flag indicating whether PERF should log statistics for the
  47  *      PM class driver.
  48  *  Parameters:
  49  *      enable_perf:    Location to store flag.  0 indicates the key was
  50  *                      not found, or had a zero value.  A nonzero value
  51  *                      means the key was found and had a nonzero value.
  52  *  Returns:
  53  *  Requires:
  54  *      enable_perf != NULL;
  55  *  Ensures:
  56  */
  57 extern void cfg_get_perf_value(bool *enable_perf);
  58
  59 /*
  60  *  ======== cfg_get_zl_file ========
  61  *  Purpose:
  62  *      Retreive the ZLFile, if any, for this board.
  63  *  Parameters:
  64  *      dev_node_obj: Handle to the dev_node who's driver we are querying.
  65  *      buf_size:       Size of buffer.
  66  *      str_zl_file_name: Ptr to character buf to hold ZLFileName.
  67  *  Returns:
  68  *      0:                Success.
  69  *      -EFAULT: str_zl_file_name is invalid or dev_node_obj is invalid.
  70  *      -ENODATA: couldn't find the ZLFileName.
  71  *  Requires:
  72  *      CFG initialized.
  73  *  Ensures:
  74  *      0:    Not more than buf_size bytes were copied into
  75  *                  str_zl_file_name, and *str_zl_file_name contains ZLFileName
  76  *                  for this devnode.
  77  */
  78 extern int cfg_get_zl_file(struct cfg_devnode *dev_node_obj,
  79                                   u32 buf_size, char *str_zl_file_name);
  80
  81 /*
  82  *  ======== CFG_SetDrvObject ========
  83  *  Purpose:
  84  *      Store the Driver Object handle.
  85  *  Parameters:
  86  *      value:          Arbitrary value to store.
  87  *      dw_type          Type of Object to Store
  88  *  Returns:
  89  *      0:        Success.
  90  *      -EPERM:      Internal Error.
  91  *  Requires:
  92  *      CFG initialized.
  93  *  Ensures:
  94  *      0:        The Private u32 was successfully set.
  95  */
  96 extern int cfg_set_object(u32 value, u8 dw_type);
  97
  98 #endif /* CFG_ */