Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

proc.h

Go to the documentation of this file.
00001 /** ============================================================================
00002  *  @file   proc.h
00003  *
00004  *  @path   $(DSPLINK)/gpp/inc/usr/
00005  *
00006  *  @brief  Defines the interfaces and data structures for the API sub-component
00007  *          PROC.
00008  *
00009  *  @ver    1.65.00.03
00010  *  ============================================================================
00011  *  @copyright Copyright (C) 2002-2009, Texas Instruments Incorporated -
00012  *  http://www.ti.com/
00013  *
00014  *  Redistribution and use in source and binary forms, with or without
00015  *  modification, are permitted provided that the following conditions
00016  *  are met:
00017  *  
00018  *  *  Redistributions of source code must retain the above copyright
00019  *     notice, this list of conditions and the following disclaimer.
00020  *  
00021  *  *  Redistributions in binary form must reproduce the above copyright
00022  *     notice, this list of conditions and the following disclaimer in the
00023  *     documentation and/or other materials provided with the distribution.
00024  *  
00025  *  *  Neither the name of Texas Instruments Incorporated nor the names of
00026  *     its contributors may be used to endorse or promote products derived
00027  *     from this software without specific prior written permission.
00028  *  
00029  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00030  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00031  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00032  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00033  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00034  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00035  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
00036  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00037  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
00038  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00039  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00040  *  ============================================================================
00041  */
00042 
00043 
00044 #if !defined (PROC_H)
00045 #define PROC_H
00046 
00047 
00048 /*  ----------------------------------- DSP/BIOS LINK Headers       */
00049 #include <dsplink.h>
00050 #include <procdefs.h>
00051 #include <linkcfgdefs.h>
00052 
00053 /*  ----------------------------------- Profiling                       */
00054 #if defined (DDSP_PROFILE)
00055 #include <profile.h>
00056 #endif /* #if defined (DDSP_PROFILE) */
00057 
00058 
00059 #if defined (__cplusplus)
00060 extern "C" {
00061 #endif /* defined (__cplusplus) */
00062 
00063 
00064 /** ============================================================================
00065  *  @func   PROC_setup
00066  *
00067  *  @brief  Sets up the necessary data structures for the PROC sub-component.
00068  *
00069  *  @param linkCfg
00070  *             Pointer to the configuration information structure for DSP/BIOS
00071  *             LINK.
00072  *             If NULL, indicates that default configuration should be used.
00073  *
00074  *  @return DSP_SOK
00075  *              Operation successfully completed.
00076  *          DSP_SALREADYSETUP
00077  *              The DSPLink driver is already setup in this process.
00078  *          DSP_ECONFIG
00079  *              Error in specified dynamic configuration. Please check
00080  *              CFG_<PLATFORM>.c
00081  *          DSP_EMEMORY
00082  *              Operation failed due to memory error.
00083  *          DSP_EFAIL
00084  *              General failure.
00085  *
00086  *  @pre    The configuration information structure has been updated with
00087  *          application specific information. If no configuration is
00088  *          specified the default configuration will be used.
00089  *
00090  *  @post   None
00091  *
00092  *  @see    PROC_destroy
00093  *  ============================================================================
00094  */
00095 EXPORT_API
00096 DSP_STATUS
00097 PROC_setup (IN LINKCFG_Object * linkCfg) ;
00098 
00099 
00100 /** ============================================================================
00101  *  @func   PROC_destroy
00102  *
00103  *  @brief  Destroys the data structures for the PROC component,
00104  *          allocated earlier by a call to PROC_setup ().
00105  *
00106  *  @param None
00107  *
00108  *  @return DSP_SOK
00109  *              Operation successfully completed.
00110  *          DSP_SDESTROYED
00111  *              The final client has finalized the driver.
00112  *          DSP_EACCESSDENIED
00113  *              The DSPLink driver was not setup in this process.
00114  *          DSP_ESETUP
00115  *              The DSPLink driver was not setup.
00116  *          DSP_EMEMORY
00117  *              Operation failed due to memory error.
00118  *          DSP_EFAIL
00119  *              General failure.
00120  *
00121  *  @pre    All DSP/BIOS Link operations are complete.
00122  *
00123  *  @post   None
00124  *
00125  *  @see    PROC_setup
00126  *  ============================================================================
00127  */
00128 EXPORT_API
00129 DSP_STATUS
00130 PROC_destroy (Void) ;
00131 
00132 
00133 /** ============================================================================
00134  *  @func   PROC_attach
00135  *
00136  *  @brief  Attaches the client to the specified DSP and also
00137  *          initializes the DSP (if required).
00138  *
00139  *  @param procId
00140  *             DSP identifier.
00141  *  @param attr
00142  *             Attributes for the processor on which attach is to be done.
00143  *
00144  *  @return DSP_SOK
00145  *              Operation successfully completed.
00146  *          DSP_SALREADYATTACHED
00147  *              Successful attach. Also, indicates that another client has
00148  *              already attached to DSP.
00149  *          DSP_EINVALIDARG
00150  *              Parameter ProcId is invalid.
00151  *          DSP_EACCESSDENIED
00152  *              Not allowed to access the DSP.
00153  *          DSP_EALREADYCONNECTED
00154  *              Another thread of the same process has already attached to the
00155  *              processor.
00156  *          DSP_EWRONGSTATE
00157  *              Incorrect state for completing the requested operation.
00158  *          DSP_EFAIL
00159  *              General failure, unable to attach to processor.
00160  *
00161  *  @pre    procId must be valid.
00162  *          PROC_setup has been successful.
00163  *
00164  *  @post   None
00165  *
00166  *  @see    PROC_detach
00167  *  ============================================================================
00168  */
00169 EXPORT_API
00170 DSP_STATUS
00171 PROC_attach (IN  ProcessorId   procId,
00172                  PROC_Attrs *  attr) ;
00173 
00174 
00175 /** ============================================================================
00176  *  @func   PROC_detach
00177  *
00178  *  @brief  Detaches the client from specified processor.
00179  *          If the caller is the owner of the processor, this function releases
00180  *          all the resources that this component uses and puts the DSP in an
00181  *          unusable state (from application perspective).
00182  *
00183  *  @param procId
00184  *              DSP identifier.
00185  *
00186  *  @return DSP_SOK
00187  *              Operation successfully completed.
00188  *          DSP_SDETACHED
00189  *              The final process has detached from the specific processor.
00190  *          DSP_EINVALIDARG
00191  *              Invalid ProcId parameter.
00192  *          DSP_ESETUP
00193  *              The DSPLink driver was not setup.
00194  *          DSP_EACCESSDENIED
00195  *              Not allowed to access the DSP.
00196  *          DSP_EATTACHED
00197  *              Not attached to the target processor.
00198  *          DSP_EWRONGSTATE
00199  *              Incorrect state for completing the requested operation.
00200  *          DSP_EFAIL
00201  *              General failure, unable to detach.
00202  *
00203  *  @pre    procId must be valid.
00204  *          All DSP/BIOS Link operations are complete.
00205  *
00206  *  @post   None
00207  *
00208  *  @see    PROC_attach
00209  *  ============================================================================
00210  */
00211 EXPORT_API
00212 DSP_STATUS
00213 PROC_detach (IN  ProcessorId procId) ;
00214 
00215 
00216 /** ============================================================================
00217  *  @func   PROC_getState
00218  *
00219  *  @brief  Gets the current status of DSP by querying the Link Driver.
00220  *
00221  *  @param procId
00222  *              DSP identifier.
00223  *  @param procState
00224  *              Placeholder for processor state.
00225  *
00226  *  @return DSP_SOK
00227  *              Operation successfully completed.
00228  *          DSP_EINVALIDARG
00229  *              Invalid ProcId and/or procState argument.
00230  *
00231  *  @pre    procId must be valid.
00232  *          procState must be a valid pointer.
00233  *
00234  *  @post   None
00235  *
00236  *  @see    PROC_load, PROC_start, PROC_stop, PROC_Idle
00237  *  ============================================================================
00238  */
00239 EXPORT_API
00240 DSP_STATUS
00241 PROC_getState (IN   ProcessorId    procId,
00242                OUT  PROC_State *   procState) ;
00243 
00244 
00245 /** ============================================================================
00246  *  @func   PROC_load
00247  *
00248  *  @brief  Loads the specified DSP executable on the target DSP.
00249  *          It ensures that the caller owns the DSP.
00250  *
00251  *  @param procId
00252  *              DSP identifier.
00253  *  @param imagePath
00254  *              Full path to the image file to load on DSP.
00255  *  @param argc
00256  *              Number of argument to be passed to the base image upon start.
00257  *  @param argv
00258  *              Arguments to be passed to DSP main application.
00259  *
00260  *  @return DSP_SOK
00261  *              Operation successfully completed.
00262  *          DSP_SALREADYLOADED
00263  *              The specified processor has already been loaded.
00264  *          DSP_EINVALIDARG
00265  *              Invalid ProcId argument.
00266  *          DSP_EACCESSDENIED
00267  *              Not allowed to access the DSP.
00268  *          DSP_ESETUP
00269  *              The DSPLink driver has not been setup.
00270  *          DSP_EATTACHED
00271  *              This process has not attached to the specified processor.
00272  *          DSP_EPENDING
00273  *              H/W specific error. The request can’t be serviced at this
00274  *              point of time.
00275  *          DSP_EFILE
00276  *              Invalid base image.
00277  *          DSP_ESIZE
00278  *              Size of the .args section is not sufficient to hold the passed
00279  *              arguments.
00280  *          DSP_EFAIL
00281  *              General failure, unable to load image on DSP.
00282  *          DSP_EWRONGSTATE
00283  *              Incorrect state for completing the requested operation.
00284  *
00285  *  @pre    procId must be valid.
00286  *          imagePath must be a valid pointer.
00287  *          If argc is 0 then argv must be NULL pointer.
00288  *          If argc is non-zero then argv must be a valid pointer.
00289  *          PROC_setup and PROC_attach have been successful.
00290  *
00291  *  @post   None
00292  *
00293  *  @see    PROC_attach, PROC_loadSection
00294  *  ============================================================================
00295  */
00296 EXPORT_API
00297 DSP_STATUS
00298 PROC_load (IN   ProcessorId  procId,
00299            IN   Char8 *      imagePath,
00300            IN   Uint32       argc,
00301            IN   Char8 **     argv) ;
00302 
00303 
00304 /** ============================================================================
00305  *  @func   PROC_loadSection
00306  *
00307  *  @brief  Loads the specified section of DSP executable onto the target DSP.
00308  *          It ensures that the client owns the DSP.
00309  *
00310  *  @param procId
00311  *              DSP identifier.
00312  *  @param imagePath
00313  *              Full path to the image file.
00314  *  @param sectID
00315  *              Section ID of section to load.
00316  *
00317  *  @return DSP_SOK
00318  *              Operation successfully completed.
00319  *          DSP_EINVALIDARG
00320  *              Invalid ProcId argument.
00321  *          DSP_EPENDING
00322  *              H/W specific error. The request can’t be serviced at this
00323  *              point of time.
00324  *          DSP_EFILE
00325  *              Invalid ImagePath parameter.
00326  *          DSP_EINVALIDSECTION
00327  *              Invalid section name.
00328  *          DSP_EACCESSDENIED
00329  *              Not allowed to access the DSP.
00330  *          DSP_EFAIL
00331  *              General failure, unable to load section on DSP.
00332  *          DSP_EWRONGSTATE
00333  *              Incorrect state for completing the requested operation.
00334  *
00335  *  @pre    procId must be valid.
00336  *          imagePath must be a valid pointer.
00337  *          PROC_attach has been successful.
00338  *
00339  *  @post   None
00340  *
00341  *  @see    PROC_attach, PROC_load
00342  *  ============================================================================
00343  */
00344 EXPORT_API
00345 DSP_STATUS
00346 PROC_loadSection (IN    ProcessorId  procId,
00347                   IN    Char8 *      imagePath,
00348                   IN    Uint32       sectID) ;
00349 
00350 
00351 /** ============================================================================
00352  *  @func   PROC_read
00353  *
00354  *  @brief  This function allows GPP side applications to read from the DSP
00355  *          memory space.
00356  *
00357  *  @param procId
00358  *              Processor ID of the target DSP.
00359  *  @param dspAddr
00360  *              Address of the DSP memory region from where to read.
00361  *  @param numBytes
00362  *              Number of bytes to be read
00363  *  @param buffer
00364  *              User specified buffer to contain the data from DSP memory space
00365  *
00366  *  @return DSP_SOK
00367  *              Operation successfully completed.
00368  *          DSP_EPENDING
00369  *              H/W specific error. The request can’t be serviced at this
00370  *              point of time.
00371  *          DSP_EINVALIDARG
00372  *              Invalid argument.
00373  *          DSP_EFAIL
00374  *              General failure, unable to load section on DSP.
00375  *
00376  *  @pre    procId must be valid.
00377  *          buffer must be valid.
00378  *          PROC_attach has been successful.
00379  *          For DM642, the memory region must be mapped to GPP address
00380  *          space.
00381  *
00382  *
00383  *  @post   None
00384  *
00385  *  @see    PROC_write
00386  *  ============================================================================
00387  */
00388 EXPORT_API
00389 DSP_STATUS
00390 PROC_read (IN     ProcessorId    procId,
00391            IN     Uint32         dspAddr,
00392            IN     Uint32         numBytes,
00393            IN OUT Pvoid          buffer) ;
00394 
00395 
00396 /** ============================================================================
00397  *  @func   PROC_write
00398  *
00399  *  @brief  This function allows GPP side applications to write to the DSP
00400  *          memory space
00401  *
00402  *  @param procId
00403  *              Processor ID of the target DSP.
00404  *  @param dspAddr
00405  *              Address of the DSP memory region from where the data is
00406  *              to be written to.
00407  *  @param numBytes
00408  *              Number of bytes to be written
00409  *  @param buffer
00410  *              User specified buffer with data to be written into DSP memory
00411  *              space
00412  *
00413  *  @return DSP_SOK
00414  *              Operation successfully completed.
00415  *          DSP_EPENDING
00416  *              H/W specific error. The request can’t be serviced at this
00417  *              point of time.
00418  *          DSP_EINVALIDARG
00419  *              Invalid argument.
00420  *          DSP_EFAIL
00421  *              General failure, unable to load section on DSP.
00422  *
00423  *  @pre    procId must be valid.
00424  *          buffer must be valid.
00425  *          PROC_attach has been successful.
00426  *          For DM642, the memory region must be mapped to GPP address
00427  *          space.
00428  *
00429  *  @post   None
00430  *
00431  *  @see    PROC_read
00432  *  ============================================================================
00433  */
00434 EXPORT_API
00435 DSP_STATUS
00436 PROC_write (IN ProcessorId    procId,
00437             IN Uint32         dspAddr,
00438             IN Uint32         numBytes,
00439             IN Pvoid          buffer) ;
00440 
00441 
00442 /** ============================================================================
00443  *  @func   PROC_start
00444  *
00445  *  @brief  Starts execution of the loaded code on DSP from the starting
00446  *          point specified in the DSP executable loaded earlier by call to
00447  *          PROC_load ().
00448  *
00449  *  @param procId
00450  *              DSP Identifier.
00451  *
00452  *  @return DSP_SOK
00453  *              Operation successfully completed.
00454  *          DSP_SALREADYSTARTED
00455  *              The specified processor has already been started.
00456  *          DSP_EINVALIDARG
00457  *              Invalid ProcId argument.
00458  *          DSP_EPENDING
00459  *              H/W specific error. The request can’t be serviced at this
00460  *              point of time.
00461  *          DSP_EACCESSDENIED
00462  *              Not allowed to access the DSP.
00463  *          DSP_ESETUP
00464  *              The DSPLink driver has not been setup.
00465  *          DSP_EATTACHED
00466  *              This process has not attached to the specified processor.
00467  *          DSP_EALREADYSTARTED
00468  *              The specified processor has already been started in this process
00469  *          DSP_EWRONGSTATE
00470  *              Incorrect state for completing the requested operation.
00471  *          DSP_ECONFIG
00472  *              The specified processor could not be started. Driver handshake
00473  *              failed due to DSP driver initialization/configuration failure.
00474  *          DSP_EFAIL
00475  *              General failure, unable to start DSP.
00476  *
00477  *  @pre    procId must be valid.
00478  *          PROC_attach has been successful.
00479  *          If the application uses POOL, POOL_open i.e POOL configuration has
00480  *          been successful.
00481  *          All setup and initialization needed for DSP to start execution
00482  *          has been done.
00483  *
00484  *  @post   None
00485  *
00486  *  @see    PROC_attach, PROC_load, PROC_stop
00487  *  ============================================================================
00488  */
00489 EXPORT_API
00490 DSP_STATUS
00491 PROC_start (IN ProcessorId procId) ;
00492 
00493 
00494 /** ============================================================================
00495  *  @func   PROC_stop
00496  *
00497  *  @brief  Stops the DSP.
00498  *
00499  *  @param procId
00500  *              DSP Identifier.
00501  *
00502  *  @return DSP_SOK
00503  *              Operation successfully completed.
00504  *          DSP_SSTOPPED
00505  *              The final process has stopped the DSP execution.
00506  *          DSP_EINVALIDARG
00507  *              Invalid ProcId argument.
00508  *          DSP_EACCESSDENIED
00509  *              Not allowed to access the DSP.
00510  *          DSP_ESETUP
00511  *              The DSPLink driver has not been setup.
00512  *          DSP_EATTACHED
00513  *              This process has not attached to the specified processor.
00514  *          DSP_ESTARTED
00515  *              The specified processor has not been started.
00516  *          DSP_EWRONGSTATE
00517  *              Incorrect state for completing the requested operation.
00518  *          DSP_EFAIL
00519  *              General failure, unable to stop DSP.
00520  *
00521  *  @pre    procId must be valid.
00522  *          All DSP/BIOS Link operations are complete.
00523  *
00524  *  @post   None
00525  *
00526  *  @see    PROC_attach, PROC_load, PROC_start
00527  *  ============================================================================
00528  */
00529 EXPORT_API
00530 DSP_STATUS
00531 PROC_stop (IN ProcessorId procId) ;
00532 
00533 
00534 /** ============================================================================
00535  *  @func   PROC_control
00536  *
00537  *  @brief  Provides a hook to perform device dependent control operations on
00538  *          the DSP.
00539  *
00540  *  @param procId
00541  *              DSP Identifier.
00542  *  @param cmd
00543  *              Command id.
00544  *  @param arg
00545  *              Optional argument for the specified command.
00546  *
00547  *  @return DSP_SOK
00548  *              Operation successfully completed.
00549  *          DSP_EFAIL
00550  *              General failure.
00551  *
00552  *  @pre    procId must be valid.
00553  *          PROC_attach has been successful.
00554  *
00555  *  @post   None
00556  *
00557  *  @see    PROC_attach
00558  *  ============================================================================
00559  */
00560 EXPORT_API
00561 DSP_STATUS
00562 PROC_control (IN  ProcessorId procId,
00563               IN  Int32       cmd,
00564                   Pvoid       arg) ;
00565 
00566 
00567 /** ============================================================================
00568  *  @func   PROC_GetSymbolAddress
00569  *
00570  *  @brief  Gets the DSP address corresponding to a symbol within a DSP
00571  *          executable currently loaded on the DSP.
00572  *
00573  *  @param procId
00574  *              DSP Identifier.
00575  *  @param symbolName
00576  *              name of the symbol.
00577  *  @param dspAddr
00578  *              pointer to get the dsp address corresponding to symbolName.
00579  *
00580  *  @modif  None
00581  *  ============================================================================
00582  */
00583 EXPORT_API
00584 DSP_STATUS
00585 PROC_GetSymbolAddress (IN   ProcessorId   procId,
00586                        IN   Char8 *       symbolName,
00587                        OUT  Uint32 *      dspAddr) ;
00588 
00589 
00590 #if defined (DDSP_PROFILE)
00591 /** ============================================================================
00592  *  @func   PROC_instrument
00593  *
00594  *  @brief  Gets the instrumentation data associated with PROC sub-component.
00595  *
00596  *  @param procId
00597  *              Identifier for processor for which instrumentation
00598  *              information is to be obtained.
00599  *  @param retVal
00600  *              OUT argument to contain the instrumentation information.
00601  *
00602  *  @return DSP_SOK
00603  *              Operation successfully completed.
00604  *          DSP_EINVALIDARG
00605  *              retVal is invalid.
00606  *
00607  *  @pre    procId must be valid.
00608  *          retVal must be a valid pointer.
00609  *          PROC_attach has been successful.
00610  *          Profiling has been selected in the configuration.
00611  *
00612  *  @post   None
00613  *
00614  *  @see    None
00615  *  ============================================================================
00616  */
00617 EXPORT_API
00618 DSP_STATUS
00619 PROC_instrument (IN ProcessorId procId, OUT PROC_Instrument * retVal) ;
00620 #endif /* defined (DDSP_PROFILE) */
00621 
00622 
00623 #if defined (DDSP_DEBUG)
00624 /** ============================================================================
00625  *  @func   PROC_debug
00626  *
00627  *  @brief  Prints the debug information summarizing the current status
00628  *          of the PROC component.
00629  *
00630  *  @param procId
00631  *              Identifier for processor.
00632  *
00633  *  @return None
00634  *
00635  *  @pre    procId must be valid.
00636  *          PROC_setup and PROC_attach have been successful.
00637  *
00638  *  @post   None
00639  *
00640  *  @see    None
00641  *  ============================================================================
00642  */
00643 EXPORT_API
00644 Void
00645 PROC_debug (IN ProcessorId procId) ;
00646 #endif /* defined (DDSP_DEBUG) */
00647 
00648 
00649 /** ============================================================================
00650  *  @deprecated The deprecated API POOL_TranslateAddr has been replaced
00651  *              with POOL_translateAddr.
00652  *              This has been done to follow DSP/BIOS codinf guidelines and
00653  *              have a uniform naming convention for the API's on both GPP
00654  *              as well as DSP.
00655  *
00656  *  ============================================================================
00657  */
00658 EXPORT_API
00659 DSP_STATUS
00660 PROC_Setup (Void) ;
00661 
00662 /** ============================================================================
00663  *  @deprecated The deprecated API PROC_Destroy has been replaced
00664  *              with PROC_destroy.
00665  *              This has been done to follow DSP/BIOS codinf guidelines and
00666  *              have a uniform naming convention for the API's on both GPP
00667  *              as well as DSP.
00668  *
00669  *  ============================================================================
00670  */
00671 #define PROC_Destroy               PROC_destroy
00672 
00673 /** ============================================================================
00674  *  @deprecated The deprecated API PROC_Attach has been replaced
00675  *              with PROC_attach.
00676  *              This has been done to follow DSP/BIOS codinf guidelines and
00677  *              have a uniform naming convention for the API's on both GPP
00678  *              as well as DSP.
00679  *
00680  *  ============================================================================
00681  */
00682 #define PROC_Attach                PROC_attach
00683 
00684 /** ============================================================================
00685  *  @deprecated The deprecated API PROC_Detach has been replaced
00686  *              with PROC_detach.
00687  *              This has been done to follow DSP/BIOS codinf guidelines and
00688  *              have a uniform naming convention for the API's on both GPP
00689  *              as well as DSP.
00690  *
00691  *  ============================================================================
00692  */
00693 #define PROC_Detach                PROC_detach
00694 
00695 /** ============================================================================
00696  *  @deprecated The deprecated API PROC_GetState has been replaced
00697  *              with PROC_getState.
00698  *              This has been done to follow DSP/BIOS codinf guidelines and
00699  *              have a uniform naming convention for the API's on both GPP
00700  *              as well as DSP.
00701  *
00702  *  ============================================================================
00703  */
00704 #define PROC_GetState              PROC_getState
00705 
00706 /** ============================================================================
00707  *  @deprecated The deprecated API PROC_Load has been replaced
00708  *              with PROC_load.
00709  *              This has been done to follow DSP/BIOS codinf guidelines and
00710  *              have a uniform naming convention for the API's on both GPP
00711  *              as well as DSP.
00712  *
00713  *  ============================================================================
00714  */
00715 #define PROC_Load                  PROC_load
00716 
00717 /** ============================================================================
00718  *  @deprecated The deprecated API PROC_LoadSection has been replaced
00719  *              with PROC_loadSection.
00720  *              This has been done to follow DSP/BIOS codinf guidelines and
00721  *              have a uniform naming convention for the API's on both GPP
00722  *              as well as DSP.
00723  *
00724  *  ============================================================================
00725  */
00726 #define PROC_LoadSection           PROC_loadSection
00727 
00728 /** ============================================================================
00729  *  @deprecated The deprecated API PROC_Read has been replaced
00730  *              with PROC_read.
00731  *              This has been done to follow DSP/BIOS codinf guidelines and
00732  *              have a uniform naming convention for the API's on both GPP
00733  *              as well as DSP.
00734  *
00735  *  ============================================================================
00736  */
00737 #define PROC_Read                  PROC_read
00738 
00739 /** ============================================================================
00740  *  @deprecated The deprecated API PROC_Write has been replaced
00741  *              with PROC_write.
00742  *              This has been done to follow DSP/BIOS codinf guidelines and
00743  *              have a uniform naming convention for the API's on both GPP
00744  *              as well as DSP.
00745  *
00746  *  ============================================================================
00747  */
00748 #define PROC_Write                 PROC_write
00749 
00750 /** ============================================================================
00751  *  @deprecated The deprecated API PROC_Start has been replaced
00752  *              with PROC_start.
00753  *              This has been done to follow DSP/BIOS codinf guidelines and
00754  *              have a uniform naming convention for the API's on both GPP
00755  *              as well as DSP.
00756  *
00757  *  ============================================================================
00758  */
00759 #define PROC_Start                 PROC_start
00760 
00761 /** ============================================================================
00762  *  @deprecated The deprecated API PROC_Stop has been replaced
00763  *              with PROC_stop.
00764  *              This has been done to follow DSP/BIOS codinf guidelines and
00765  *              have a uniform naming convention for the API's on both GPP
00766  *              as well as DSP.
00767  *
00768  *  ============================================================================
00769  */
00770 #define PROC_Stop                  PROC_stop
00771 
00772 /** ============================================================================
00773  *  @deprecated The deprecated API PROC_Control has been replaced
00774  *              with PROC_control.
00775  *              This has been done to follow DSP/BIOS codinf guidelines and
00776  *              have a uniform naming convention for the API's on both GPP
00777  *              as well as DSP.
00778  *
00779  *  ============================================================================
00780  */
00781 #define PROC_Control               PROC_control
00782 
00783 #if defined (DDSP_DEBUG)
00784 /** ============================================================================
00785  *  @deprecated The deprecated API PROC_Debug has been replaced
00786  *              with PROC_debug.
00787  *              This has been done to follow DSP/BIOS codinf guidelines and
00788  *              have a uniform naming convention for the API's on both GPP
00789  *              as well as DSP.
00790  *
00791  *  ============================================================================
00792  */
00793 #define PROC_Debug                 PROC_debug
00794 #endif /* defined (DDSP_DEBUG) */
00795 
00796 
00797 #if defined (__cplusplus)
00798 }
00799 #endif /* defined (__cplusplus) */
00800 
00801 
00802 #endif /* !defined (PROC_H) */

Generated on Fri Jul 16 14:34:03 2010 for DSP/BIOSLink by  doxygen 1.4.4