cpu.h

Go to the documentation of this file.

/* --COPYRIGHT--,BSD
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --/COPYRIGHT--*/
#ifndef __CPU_H__
#define __CPU_H__



// **************************************************************************
// the includes

#include "sw/modules/types/src/types.h"




#ifdef __cplusplus
extern "C" {
#endif


// **************************************************************************
// the defines


#define  EINT   asm(" clrc INTM")

#define  ENABLE_INTERRUPTS    asm(" clrc INTM")

#define  DINT   asm(" setc INTM")

#define  DISABLE_INTERRUPTS   asm(" setc INTM")

#define  ERTM   asm(" clrc DBGM")

#define  DRTM   asm(" setc DBGM")

#define  EALLOW asm(" EALLOW")

#define  ENABLE_PROTECTED_REGISTER_WRITE_MODE  asm(" EALLOW")

#define  EDIS   asm(" EDIS")

#define  DISABLE_PROTECTED_REGISTER_WRITE_MODE asm(" EDIS")

#define  ESTOP0  asm(" ESTOP0")

#define  IDLE  asm(" IDLE")

#define  CPU_IER_INT1_BITS          (1 << 0)

#define  CPU_IER_INT2_BITS          (1 << 1)

#define  CPU_IER_INT3_BITS          (1 << 2)

#define  CPU_IER_INT4_BITS          (1 << 3)

#define  CPU_IER_INT5_BITS          (1 << 4)

#define  CPU_IER_INT6_BITS          (1 << 5)

#define  CPU_IER_INT7_BITS          (1 << 6)

#define  CPU_IER_INT8_BITS          (1 << 7)

#define  CPU_IER_INT9_BITS          (1 << 8)

#define  CPU_IER_INT10_BITS         (1 << 9)

#define  CPU_IER_INT11_BITS         (1 << 10)

#define  CPU_IER_INT12_BITS         (1 << 11)

#define  CPU_IER_INT13_BITS         (1 << 12)

#define  CPU_IER_INT14_BITS         (1 << 13)

#define  CPU_IER_DLOGINT_BITS       (1 << 14)

#define  CPU_IER_RTOSINT_BITS       (1 << 15)



#define  CPU_IFR_INT1_BITS          (1 << 0)

#define  CPU_IFR_INT2_BITS          (1 << 1)

#define  CPU_IFR_INT3_BITS          (1 << 2)

#define  CPU_IFR_INT4_BITS          (1 << 3)

#define  CPU_IFR_INT5_BITS          (1 << 4)

#define  CPU_IFR_INT6_BITS          (1 << 5)

#define  CPU_IFR_INT7_BITS          (1 << 6)

#define  CPU_IFR_INT8_BITS          (1 << 7)

#define  CPU_IFR_INT9_BITS          (1 << 8)

#define  CPU_IFR_INT10_BITS         (1 << 9)

#define  CPU_IFR_INT11_BITS         (1 << 10)

#define  CPU_IFR_INT12_BITS         (1 << 11)

#define  CPU_IFR_INT13_BITS         (1 << 12)

#define  CPU_IFR_INT14_BITS         (1 << 13)

#define  CPU_IFR_DLOGINT_BITS       (1 << 14)

#define  CPU_IFR_RTOSINT_BITS       (1 << 15)


#define  CPU_DBGIER_INT1_BITS       (1 << 0)

#define  CPU_DBGIER_INT2_BITS       (1 << 1)

#define  CPU_DBGIER_INT3_BITS       (1 << 2)

#define  CPU_DBGIER_INT4_BITS       (1 << 3)

#define  CPU_DBGIER_INT5_BITS       (1 << 4)

#define  CPU_DBGIER_INT6_BITS       (1 << 5)

#define  CPU_DBGIER_INT7_BITS       (1 << 6)

#define  CPU_DBGIER_INT8_BITS       (1 << 7)

#define  CPU_DBGIER_INT9_BITS       (1 << 8)

#define  CPU_DBGIER_INT10_BITS      (1 << 9)

#define  CPU_DBGIER_INT11_BITS      (1 << 10)

#define  CPU_DBGIER_INT12_BITS      (1 << 11)

#define  CPU_DBGIER_INT13_BITS      (1 << 12)

#define  CPU_DBGIER_INT14_BITS      (1 << 13)

#define  CPU_DBGIER_DLOGINT_BITS    (1 << 14)

#define  CPU_DBGIER_RTOSINT_BITS    (1 << 15)



#define  CPU_ST0_SXM_BITS           (1 << 0)

#define  CPU_ST0_OVM_BITS           (1 << 1)

#define  CPU_ST0_TC_BITS            (1 << 2)

#define  CPU_ST0_C_BITS             (1 << 3)

#define  CPU_ST0_Z_BITS             (1 << 4)

#define  CPU_ST0_N_BITS             (1 << 5)

#define  CPU_ST0_V_BITS             (1 << 6)

#define  CPU_ST0_PW_BITS            (7 << 7)

#define  CPU_ST0_OVCOVCU_BITS       (63 << 10)



#define  CPU_ST1_INTM_BITS          (1 << 0)

#define  CPU_ST1_DBGM_BITS          (1 << 1)

#define  CPU_ST1_PAGE0_BITS         (1 << 2)

#define  CPU_ST1_VMAP_BITS          (1 << 3)

#define  CPU_ST1_SPA_BITS           (1 << 4)

#define  CPU_ST1_LOOP_BITS          (1 << 5)

#define  CPU_ST1_EALLOW_BITS        (1 << 6)

#define  CPU_ST1_IDLESTAT_BITS      (1 << 7)

#define  CPU_ST1_AMODE_BITS         (1 << 8)

#define  CPU_ST1_OBJMODE_BITS       (1 << 9)

#define  CPU_ST1_MOM1MAP_BITS       (1 << 11)

#define  CPU_ST1_XF_BITS            (1 << 12)

#define  CPU_ST1_ARP_BITS           (7 << 13)


// **************************************************************************
// the typedefs

typedef enum
{
  CPU_ExtIntNumber_1=0,      
  CPU_ExtIntNumber_2,        
  CPU_ExtIntNumber_3         
} CPU_ExtIntNumber_e;


typedef enum
{
  CPU_IntNumber_1=(1 << 0),      
  CPU_IntNumber_2=(1 << 1),      
  CPU_IntNumber_3=(1 << 2),      
  CPU_IntNumber_4=(1 << 3),      
  CPU_IntNumber_5=(1 << 4),      
  CPU_IntNumber_6=(1 << 5),      
  CPU_IntNumber_7=(1 << 6),      
  CPU_IntNumber_8=(1 << 7),      
  CPU_IntNumber_9=(1 << 8),      
  CPU_IntNumber_10=(1 << 9),     
  CPU_IntNumber_11=(1 << 10),    
  CPU_IntNumber_12=(1 << 11),    
  CPU_IntNumber_13=(1 << 12),    
  CPU_IntNumber_14=(1 << 13)     
} CPU_IntNumber_e;


typedef struct _CPU_Obj_
{
  uint_least8_t   tmp;   
} CPU_Obj;


typedef struct _CPU_Obj_ *CPU_Handle;


// **************************************************************************
// the globals


extern CPU_Obj cpu;


extern cregister volatile unsigned int IFR;


extern cregister volatile unsigned int IER;


// **************************************************************************
// the function prototypes

extern void CPU_clearIntFlags(CPU_Handle cpuHandle);


extern void CPU_disableDebugInt(CPU_Handle cpuHandle);


extern void CPU_disableGlobalInts(CPU_Handle cpuHandle);


extern void CPU_disableInt(CPU_Handle cpuHandle,const CPU_IntNumber_e intNumber);


extern void CPU_disableInts(CPU_Handle cpuHandle);


extern void CPU_disableProtectedRegisterWrite(CPU_Handle cpuHandle);


extern void CPU_enableDebugInt(CPU_Handle cpuHandle);


extern void CPU_enableGlobalInts(CPU_Handle cpuHandle);


extern void CPU_enableInt(CPU_Handle cpuHandle,const CPU_IntNumber_e intNumber);


extern void CPU_enableProtectedRegisterWrite(CPU_Handle cpuHandle);


extern CPU_Handle CPU_init(void *pMemory,const size_t numBytes);


#ifdef __cplusplus
}
#endif // extern "C"

#endif  // end of __CPU_H__ definition