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

   1 /*
   2  * dspdrv.h
   3  *
   4  * DSP-BIOS Bridge driver support functions for TI OMAP processors.
   5  *
   6  * This is the Stream Interface for the DSp API.
   7  * All Device operations are performed via DeviceIOControl.
   8  *
   9  * Copyright (C) 2005-2006 Texas Instruments, Inc.
  10  *
  11  * This package is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  *
  15  * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  17  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  18  */
  19
  20 #if !defined _DSPDRV_H_
  21 #define _DSPDRV_H_
  22
  23 /*
  24  *  ======== dsp_deinit ========
  25  *  Purpose:
  26  *      This function is called by Device Manager to de-initialize a device.
  27  *      This function is not called by applications.
  28  *  Parameters:
  29  *      device_context:Handle to the device context. The XXX_Init function
  30  *      creates and returns this identifier.
  31  *  Returns:
  32  *      TRUE indicates the device successfully de-initialized. Otherwise it
  33  *      returns FALSE.
  34  *  Requires:
  35  *      device_context!= NULL. For a built in device this should never
  36  *      get called.
  37  *  Ensures:
  38  */
  39 extern bool dsp_deinit(u32 device_context);
  40
  41 /*
  42  *  ======== dsp_init ========
  43  *  Purpose:
  44  *      This function is called by Device Manager to initialize a device.
  45  *      This function is not called by applications
  46  *  Parameters:
  47  *      dw_context:  Specifies a pointer to a string containing the registry
  48  *                  path to the active key for the stream interface driver.
  49  *                  HKEY_LOCAL_MACHINE\Drivers\Active
  50  *  Returns:
  51  *      Returns a handle to the device context created. This is the our actual
  52  *      Device Object representing the DSP Device instance.
  53  *  Requires:
  54  *  Ensures:
  55  *      Succeeded:  device context > 0
  56  *      Failed:     device Context = 0
  57  */
  58 extern u32 dsp_init(u32 *init_status);
  59
  60 #endif