kernel/eka/include/nkern/arm/nk_plat.h
changeset 0 a41df078684a
child 31 56f325a607ea
equal deleted inserted replaced
-1:000000000000 0:a41df078684a
       
     1 // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of the License "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // e32\include\nkern\arm\nk_plat.h
       
    15 // 
       
    16 // WARNING: This file contains some APIs which are internal and are subject
       
    17 //          to change without notice. Such APIs should therefore not be used
       
    18 //          outside the Kernel and Hardware Services package.
       
    19 //
       
    20 
       
    21 /**
       
    22  @file
       
    23  @internalComponent
       
    24 */
       
    25 
       
    26 #ifndef __NK_ARM_H__
       
    27 #define __NK_ARM_H__
       
    28 #include <nk_cpu.h>
       
    29 
       
    30 // These macros are intended for Symbian use only.
       
    31 // It may not be possible to build the kernel if any of these macros are undefined
       
    32 #define __SCHEDULER_MACHINE_CODED__
       
    33 #define __DFC_MACHINE_CODED__
       
    34 #define __MSTIM_MACHINE_CODED__
       
    35 #define __PRI_LIST_MACHINE_CODED__
       
    36 #define __FAST_SEM_MACHINE_CODED__
       
    37 #define __FAST_MUTEX_MACHINE_CODED__
       
    38 #define __USER_CONTEXT_TYPE_MACHINE_CODED__
       
    39 #define __CLIENT_REQUEST_MACHINE_CODED__
       
    40 
       
    41 // TScheduler member data
       
    42 #define	i_Regs				iExtras[14]
       
    43 #define	i_ExcInfo			iExtras[15]		// pointer to exception info for crash debugger
       
    44 
       
    45 const TUint32 KNThreadContextFlagThumbBit0=1;
       
    46 
       
    47 #ifdef __CPU_ARM_USE_DOMAINS
       
    48 #define DOMAIN_STACK_SPACE	4
       
    49 #else
       
    50 #define DOMAIN_STACK_SPACE	0
       
    51 #endif
       
    52 #ifdef __CPU_HAS_COPROCESSOR_ACCESS_REG
       
    53 #define CAR_STACK_SPACE	4
       
    54 #else
       
    55 #define CAR_STACK_SPACE	0
       
    56 #endif
       
    57 #ifdef __CPU_HAS_VFP
       
    58 #define VFP_STACK_SPACE	4
       
    59 #else
       
    60 #define VFP_STACK_SPACE	0
       
    61 #endif
       
    62 #ifdef __CPU_HAS_CP15_THREAD_ID_REG
       
    63 #define TID_STACK_SPACE	4
       
    64 #else 
       
    65 #define TID_STACK_SPACE	0
       
    66 #endif 
       
    67 #ifdef __CPU_SUPPORT_THUMB2EE
       
    68 #define THUMB2EE_STACK_SPACE 4
       
    69 #else
       
    70 #define THUMB2EE_STACK_SPACE 0
       
    71 #endif
       
    72 
       
    73 #define EXTRA_STACK_SPACE	(DOMAIN_STACK_SPACE+CAR_STACK_SPACE+VFP_STACK_SPACE+TID_STACK_SPACE+THUMB2EE_STACK_SPACE)
       
    74 
       
    75 #ifdef __INCLUDE_REG_OFFSETS__
       
    76 // Positions of registers on stack, relative to saved SP
       
    77 #define EXTRA_WORDS	(EXTRA_STACK_SPACE/4)
       
    78 
       
    79 #ifdef __CPU_HAS_VFP
       
    80 #define SP_FPEXC	((THUMB2EE_STACK_SPACE+TID_STACK_SPACE)/4)
       
    81 #endif
       
    82 #ifdef __CPU_HAS_COPROCESSOR_ACCESS_REG
       
    83 #define	SP_CAR		((THUMB2EE_STACK_SPACE+TID_STACK_SPACE+VFP_STACK_SPACE)/4)
       
    84 #endif
       
    85 #ifdef __CPU_ARM_USE_DOMAINS
       
    86 #define SP_DACR		((THUMB2EE_STACK_SPACE+TID_STACK_SPACE+VFP_STACK_SPACE+CAR_STACK_SPACE)/4)
       
    87 #endif
       
    88 
       
    89 #define	SP_R13U		EXTRA_WORDS
       
    90 #define	SP_R14U		(SP_R13U+1)
       
    91 #define	SP_SPSR		(SP_R13U+2)
       
    92 #define	SP_R4		(SP_R13U+3)
       
    93 #define	SP_R5		(SP_R13U+4)
       
    94 #define	SP_R6		(SP_R13U+5)
       
    95 #define	SP_R7		(SP_R13U+6)
       
    96 #define	SP_R8		(SP_R13U+7)
       
    97 #define	SP_R9		(SP_R13U+8)
       
    98 #define	SP_R10		(SP_R13U+9)
       
    99 #define	SP_R11		(SP_R13U+10)
       
   100 #define	SP_PC		(SP_R13U+11)
       
   101 
       
   102 #define SP_NEXT		(SP_PC+1)		// first word on stack before reschedule
       
   103 #endif	// __INCLUDE_REG_OFFSETS__
       
   104 
       
   105 #ifdef __USER_MEMORY_GUARDS_ENABLED__
       
   106 #define USER_MEMORY_GUARD_SAVE_WORDS 2
       
   107 #else
       
   108 #define USER_MEMORY_GUARD_SAVE_WORDS 0
       
   109 #endif
       
   110 
       
   111 class TArmContextElement;
       
   112 class TArmRegSet;
       
   113 
       
   114 /** ARM-specific part of the nano-thread abstraction.
       
   115 	@internalComponent
       
   116  */
       
   117 class NThread : public NThreadBase
       
   118 	{
       
   119 public:
       
   120 	TInt Create(SNThreadCreateInfo& aInfo, TBool aInitial);
       
   121 	inline void Stillborn()
       
   122 		{}
       
   123 
       
   124 	/** Value indicating what event caused thread to enter privileged mode.
       
   125 		@publishedPartner
       
   126 		@released
       
   127 	 */
       
   128 	enum TUserContextType
       
   129 		{
       
   130 		EContextNone=0,             /**< Thread has no user context */
       
   131 		EContextException=1,		/**< Hardware exception while in user mode */
       
   132 		EContextUndefined,			
       
   133 		EContextUserInterrupt,		/**< Preempted by interrupt taken in user mode */
       
   134 		EContextUserInterruptDied,  /**< Killed while preempted by interrupt taken in user mode */
       
   135 		EContextSvsrInterrupt1,     /**< Preempted by interrupt taken in executive call handler */
       
   136 		EContextSvsrInterrupt1Died, /**< Killed while preempted by interrupt taken in executive call handler */
       
   137 		EContextSvsrInterrupt2,     /**< Preempted by interrupt taken in executive call handler */
       
   138 		EContextSvsrInterrupt2Died, /**< Killed while preempted by interrupt taken in executive call handler */
       
   139 		EContextWFAR,               /**< Blocked on User::WaitForAnyRequest() */
       
   140 		EContextWFARDied,           /**< Killed while blocked on User::WaitForAnyRequest() */
       
   141 		EContextExec,				/**< Slow executive call */
       
   142 		EContextKernel,				/**< Kernel side context (for kernel threads) */
       
   143 		EContextUserIntrCallback,	/**< Blocked/preempted in a user callback on the way back from interrupt */
       
   144 		EContextWFARCallback,		/**< Blocked/preempted in a user callback on the way back from User::WFAR */
       
   145 		};
       
   146 
       
   147 	IMPORT_C static const TArmContextElement* const* UserContextTables();
       
   148 	IMPORT_C TUserContextType UserContextType();
       
   149 	inline TInt SetUserContextType()
       
   150 		{ return iSpare3=UserContextType(); }
       
   151 	inline void ResetUserContextType()
       
   152 		{ if(iSpare3>EContextUndefined && iSpare3<EContextUserIntrCallback) iSpare3=EContextUndefined; }
       
   153 	void GetContext(TArmRegSet& aContext, TUint32& aAvailRegistersMask, const TArmContextElement* aContextTable);
       
   154 	void GetUserContext(TArmRegSet& aContext, TUint32& aAvailRegistersMask);
       
   155 	void SetUserContext(const TArmRegSet& aContext);
       
   156 	void GetSystemContext(TArmRegSet& aContext, TUint32& aAvailRegistersMask);
       
   157 
       
   158 	void ModifyUsp(TLinAddr aUsp);
       
   159 
       
   160 #ifdef __CPU_ARM_USE_DOMAINS
       
   161 	TUint32 Dacr();
       
   162 	void SetDacr(TUint32 aDacr);
       
   163 	TUint32 ModifyDacr(TUint32 aClearMask, TUint32 aSetMask);
       
   164 #endif
       
   165 
       
   166 #ifdef __CPU_HAS_COPROCESSOR_ACCESS_REG
       
   167 	void SetCar(TUint32 aDacr);
       
   168 #endif
       
   169 	IMPORT_C TUint32 Car();
       
   170 	IMPORT_C TUint32 ModifyCar(TUint32 aClearMask, TUint32 aSetMask);
       
   171 
       
   172 #ifdef __CPU_HAS_VFP
       
   173 	void SetFpExc(TUint32 aDacr);
       
   174 #endif
       
   175 	IMPORT_C TUint32 FpExc();
       
   176 	IMPORT_C TUint32 ModifyFpExc(TUint32 aClearMask, TUint32 aSetMask);
       
   177 	};
       
   178 
       
   179 
       
   180 struct SArmInterruptInfo
       
   181 	{
       
   182 	TLinAddr iIrqHandler;
       
   183 	TLinAddr iFiqHandler;
       
   184 	TUint8	 iCpuUsageFilter;
       
   185 	BTrace::THandler iBTraceHandler;
       
   186 	SCpuIdleHandler iCpuIdleHandler;
       
   187 	};
       
   188 
       
   189 extern "C" SArmInterruptInfo ArmInterruptInfo;
       
   190 
       
   191 #endif