include/fm_cleanloc.h

   1 /*
   2  *  file  fm_cleanloc.h
   3  *
   4  *  Internal prototypes and data structures for Fault Management fault
   5  *  cleanup.
   6  *
   7  *  ============================================================================
   8  *      (C) Copyright 2014, Texas Instruments, Inc.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *    Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  17  *    Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the
  20  *    distribution.
  21  *
  22  *    Neither the name of Texas Instruments Incorporated nor the names of
  23  *    its contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  27  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  28  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  29  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  30  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  36  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  *
  38  *  \par
  39 */
  40
  41 #ifndef FM_CLEANLOC_H_
  42 #define FM_CLEANLOC_H_
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /* CSL Includes */
  49 #include <ti/csl/csl_cppi.h>
  50
  51 /* FM external includes */
  52 #include <ti/instrumentation/fault_mgmt/fault_mgmt.h>
  53
  54 uint32_t fmGetDmaMaxRxCh(Cppi_CpDma dmaNum);
  55 uint32_t fmGetDmaMaxTxCh(Cppi_CpDma dmaNum);
  56
  57 Fm_Result fmCleanupInit(uint32_t fullInit);
  58 Fm_Result fmCleanCppi(Fm_ExcludedResource *excludedResList, uint32_t listSize);
  59 Fm_Result fmCleanQmssAccum(Fm_GlobalConfigParams *fmGblCfgParams, Fm_ExcludedResource *excludedResList,
  60                            uint32_t listSize);
  61 Fm_Result fmCleanQmssQueue(Fm_GlobalConfigParams *fmGblCfgParams, Fm_ExcludedResource *excludedResList,
  62                            uint32_t listSize);
  63 Fm_Result fmCleanPa(Fm_GlobalConfigParams *fmGblCfgParams, Fm_ExcludedResource *excludedResList,
  64                     uint32_t listSize);
  65 Fm_Result fmCleanSa(Fm_ExcludedResource *excludedResList, uint32_t listSize);
  66 Fm_Result fmCleanEdma3(Fm_GlobalConfigParams *fmGblCfgParams, Fm_ExcludedResource *excludedResList,
  67                        uint32_t listSize, uint32_t provideStatus);
  68 Fm_Result fmCleanSemaphores(Fm_ExcludedResource *excludedResList, uint32_t listSize);
  69 Fm_Result fmCleanCics(Fm_GlobalConfigParams *fmGblCfgParams, Fm_ExcludedResource *excludedResList,
  70                       uint32_t listSize);
  71 Fm_Result fmCleanTimers(Fm_GlobalConfigParams *fmGblCfgParams, Fm_ExcludedResource *excludedResList,
  72                         uint32_t listSize);
  73 Fm_Result fmCleanAif2(void);
  74 Fm_Result fmCleanTcp3d(void);
  75 Fm_Result fmCleanBcp(void);
  76 Fm_Result fmCleanFftc(void);
  77 Fm_Result fmCleanVcp(void);
  78
  79 #ifdef __cplusplus
  80 }
  81 #endif
  82
  83 #endif /* FM_CLEANLOC_H_ */
  84