sys/contrib/ncsw/inc/core_ext.h

   1 /* Copyright (c) 2008-2011 Freescale Semiconductor, Inc.
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *     * Redistributions of source code must retain the above copyright
   7  *       notice, this list of conditions and the following disclaimer.
   8  *     * Redistributions in binary form must reproduce the above copyright
   9  *       notice, this list of conditions and the following disclaimer in the
  10  *       documentation and/or other materials provided with the distribution.
  11  *     * Neither the name of Freescale Semiconductor nor the
  12  *       names of its contributors may be used to endorse or promote products
  13  *       derived from this software without specific prior written permission.
  14  *
  15  *
  16  * ALTERNATIVELY, this software may be distributed under the terms of the
  17  * GNU General Public License ("GPL") as published by the Free Software
  18  * Foundation, either version 2 of that License or (at your option) any
  19  * later version.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
  22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24  * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
  25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  28  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /**************************************************************************//**
  34  @File          core_ext.h
  35
  36  @Description   Generic interface to basic core operations.
  37
  38                 The system integrator must ensure that this interface is
  39                 mapped to a specific core implementation, by including the
  40                 appropriate header file.
  41 *//***************************************************************************/
  42 #ifndef __CORE_EXT_H
  43 #define __CORE_EXT_H
  44
  45
  46 #ifdef NCSW_PPC_CORE
  47 #include "ppc_ext.h"
  48 #elif defined(NCSW_VXWORKS)
  49 #include "core_vxw_ext.h"
  50 #else
  51 #error "Core is not defined!"
  52 #endif /* NCSW_CORE */
  53
  54 #if (!defined(CORE_IS_LITTLE_ENDIAN) && !defined(CORE_IS_BIG_ENDIAN))
  55 #error "Must define core as little-endian or big-endian!"
  56 #endif /* (!defined(CORE_IS_LITTLE_ENDIAN) && ... */
  57
  58
  59 /**************************************************************************//**
  60  @Function      CORE_GetId
  61
  62  @Description   Returns the core ID in the system.
  63
  64  @Return        Core ID.
  65 *//***************************************************************************/
  66 uint32_t CORE_GetId(void);
  67
  68 /**************************************************************************//**
  69  @Function      CORE_MemoryBarrier
  70
  71  @Description   This routine will cause the core to stop executing any commands
  72                 until all previous memory read/write commands are completely out
  73                 of the core's pipeline.
  74
  75  @Return        None.
  76 *//***************************************************************************/
  77 void CORE_MemoryBarrier(void);
  78
  79
  80 #endif /* __CORE_EXT_H */
  81