summaryrefslogtreecommitdiffstats
path: root/pk/ppe42/ppe42_context.h
blob: 2412565b47131df67df3c32307717e4466112496 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
#ifndef __PPE42_CONTEXT_H__
#define __PPE42_CONTEXT_H__
//-----------------------------------------------------------------------------
// *! (C) Copyright International Business Machines Corp. 2014
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ***
//-----------------------------------------------------------------------------

/// \file ppe42_context.h
/// \brief PPE42 Machine and Thread context for PK

/// \page ppe42_machine_context PPE42 Assembler Macros for PK Machine
/// Context (Critical Sections)
///
/// \section _pk_enter_critical \b _pk_critical_section_enter/exit
///
/// These macro encapsulates the instruction sequences required to enter and
/// exit critical sections, along with the machine context save for later
/// exiting the critical section.
///
/// \arg \c ctxreg A register that will hold (holds) the machine context (MSR)
/// prior to entering the critical section (to be restored) for \c
/// _pk_critical_section_enter (\c _pk_critical_section_exit).
///
/// \arg \c scrreg A scratch register required for the computation of
/// \c _pk_critical_section_enter. 
///
/// Forms:
/// 
/// \b _pk_critical_section_enter \a priority, \a ctxreg, \a scrreg - Enter a
/// critical section \n
/// \b _pk_critical_section_exit \a ctxreg - Exit a critical section

#ifdef __ASSEMBLER__

        .set    _msr_ee_bit, MSR_EE_BIT

        .macro  _pk_critical_section_enter ctxreg, scrreg
        mfmsr   \ctxreg
        wrteei  0
        .endm

        .macro  _pk_critical_section_exit ctxreg
        mtmsr   \ctxreg
        .endm
        
// ****************************************************************************
// PK context save/restore macros for 32-bit Embedded PowerPC
// ****************************************************************************

// All stack frames are 8-byte aligned in conformance with the EABI.  PK
// never saves or restores GPR2 or GPR13.  GPR13 is constant in (E)ABI
// applications - the base of the read-write small data area.  GPR2 is
// system-reserved in ABI applications, and is the base for read-only small data
// in EABI applications.

// USPRG0 holds the __PkKernelContext structure (defined in ppe42.h) that
// represents the current kernel context.  The layout is as follows:
//
// Bits   Meaning
// ==============
// 0     The 'thread_mode' flag
// 1     The 'processing_interrupt" flag
// 2:7   The thread priority of the running thread
// 8     The 'discard_ctx' flag
// 9:15  The IRQ currently being processed
// 16:31 The application specific data
//
// When PK is initialized USPRG0 is initialized to 0.  When thread-mode is
// entered (by pk_start_threads()) bit 0 is set to 1.  If desired,
// once initialized (with pk_initialize()) PK can simply
// handle interrupts, reverting back to the non-thread-mode idle loop when
// there's nothing to do.
//      

        ## ------------------------------------------------------------
        ## Unused registers for embedded PPE42`
        ## ------------------------------------------------------------

        ## Registers GPR2 and GPR13 are never saved or restored.  In ABI and 
        ## EABI applications these registers are constant.

        .set    UNUSED_GPR2,  0x2 # Dedicated; EABI read-only small data area
        .set    UNUSED_GPR13, 0xd # Dedicated; (E)ABI read-write small data area

        ## ------------------------------------------------------------
        ## The PK context layout for Embedded PPE42
        ## ------------------------------------------------------------

        .set    PK_CTX_GPR1,        0x00 # Dedicated; Stack pointer
        .set    PK_CTX_LINKAGE,     0x04 # Slot for handler to store LR 
        .set    PK_CTX_GPR3,        0x08 # Volatile;  Parameter; Return Value
        .set    PK_CTX_GPR4,        0x0c # Volatile;  Parameter
        .set    PK_CTX_GPR5,        0x10 # Volatile;  Parameter
        .set    PK_CTX_GPR6,        0x14 # Volatile;  Parameter
        .set    PK_CTX_CR,          0x18 # Condition register 
        .set    PK_CTX_LR,          0x1c # Link register

        .set    PK_CTX_GPR7,        0x20 # Volatile;  Parameter
        .set    PK_CTX_GPR8,        0x24 # Volatile;  Parameter
        .set    PK_CTX_GPR9,        0x28 # Volatile;  Parameter
        .set    PK_CTX_GPR10,       0x2c # Volatile;  Parameter
        .set    PK_CTX_GPR28,       0x30 # Non-volatile
        .set    PK_CTX_GPR29,       0x34 # Non-volatile
        .set    PK_CTX_GPR30,       0x38 # Non-volatile
        .set    PK_CTX_GPR31,       0x3c # Non-volatile

        .set    PK_CTX_XER,         0x40 # Fixed-point exception register
        .set    PK_CTX_CTR,         0x44 # Count register
        .set    PK_CTX_SRR0,        0x48 # Save/restore register 0
        .set    PK_CTX_SRR1,        0x4c # Save/restore register 1
        .set    PK_CTX_GPR0,        0x50 # Volatile;  Language specific
        .set    PK_CTX_KERNEL_CTX,  0x54 # Saved __PkKernelContext for IRQ

        .set    PK_CTX_SIZE,        0x58  # Must be 8-byte aligned

        ## ------------------------------------------------------------
        ## Push the interrupted context if necessary
        ##
        ## This macro saves off some context in preparation for calling
        ## the pk_ctx_check_discard routine.  This is an attempt to use
        ## the 32 byte cache more efficiently.
        ## 
        ## 8 Instructions
        ## ------------------------------------------------------------
        ##
        
        .macro _pk_ctx_push_as_needed branch_addr:req

        stwu    %r1,    -PK_CTX_SIZE(%r1)
        stvd    %d3,    PK_CTX_GPR3(%r1)
        mfcr    %r3
        mflr    %r4
        stvd    %d3,    PK_CTX_CR(%r1)
        _liw    %r3,    \branch_addr
        b       ctx_check_discard
        .endm


        ## ------------------------------------------------------------
        ## update the kernel context in response to an interrupt.
        ## ------------------------------------------------------------

        ## The kernel context is updated with the currently active
        ## IRQ in bits 9:15.  

        .macro  _update_kernel_context irqreg, ctxreg
        rlwimi  \ctxreg, \irqreg, 16, 9, 15 //set the irq #
        oris    \ctxreg, \ctxreg, 0x4000 //set the 'processing_interrupt' flag
        mtsprg0 \ctxreg

#if PK_KERNEL_TRACE_ENABLE
        mr      %r31, \irqreg
        srwi    \ctxreg, \ctxreg, 16
        PK_KERN_TRACE_ASM16("INTERRUPT_CONTEXT(0x%04x)", \ctxreg)
        mr      \irqreg, %r31
#endif        

        .endm

#else /* __ASSEMBLER__ */

/// PK thread context layout as a C structure.
///
/// This is the structure of the stack area pointed to by
/// thread->saved_stack_pointer when a thread is fully context-switched out.

typedef struct {
    uint32_t r1;
    uint32_t linkage;
    uint32_t r3;
    uint32_t r4;
    uint32_t r5;
    uint32_t r6;
    uint32_t cr;
    uint32_t lr;

    uint32_t r7;
    uint32_t r8;
    uint32_t r9;
    uint32_t r10;
    uint32_t r28;
    uint32_t r29;
    uint32_t r30;
    uint32_t r31;

    uint32_t xer;
    uint32_t ctr;
    uint32_t srr0;
    uint32_t srr1;
    uint32_t r0;
    uint32_t sprg0;

} PkThreadContext;


#endif /* __ASSEMBLER__ */

#endif /* __PPE42_CONTEXT_H__ */


OpenPOWER on IntegriCloud