Tidy up the 8051 sdcc port (#376)

* Tidy up the 8051 sdcc port

* Replace tabs with spaces in SDCC Cygnal port.c file.

Co-authored-by: John Lin <shaojun.lin@delonghigroup.com>
Co-authored-by: Paul Bartell <pbartell@amazon.com>
This commit is contained in:
Jack Lam 2021-08-13 02:50:52 +08:00 committed by GitHub
parent 1b38078939
commit d01801807d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -38,19 +38,19 @@
#include "task.h" #include "task.h"
/* Constants required to setup timer 2 to produce the RTOS tick. */ /* Constants required to setup timer 2 to produce the RTOS tick. */
#define portCLOCK_DIVISOR ( ( uint32_t ) 12 ) #define portCLOCK_DIVISOR ( ( uint32_t ) 12 )
#define portMAX_TIMER_VALUE ( ( uint32_t ) 0xffff ) #define portMAX_TIMER_VALUE ( ( uint32_t ) 0xffff )
#define portENABLE_TIMER ( ( uint8_t ) 0x04 ) #define portENABLE_TIMER ( ( uint8_t ) 0x04 )
#define portTIMER_2_INTERRUPT_ENABLE ( ( uint8_t ) 0x20 ) #define portTIMER_2_INTERRUPT_ENABLE ( ( uint8_t ) 0x20 )
/* The value used in the IE register when a task first starts. */ /* The value used in the IE register when a task first starts. */
#define portGLOBAL_INTERRUPT_BIT ( ( StackType_t ) 0x80 ) #define portGLOBAL_INTERRUPT_BIT ( ( StackType_t ) 0x80 )
/* The value used in the PSW register when a task first starts. */ /* The value used in the PSW register when a task first starts. */
#define portINITIAL_PSW ( ( StackType_t ) 0x00 ) #define portINITIAL_PSW ( ( StackType_t ) 0x00 )
/* Macro to clear the timer 2 interrupt flag. */ /* Macro to clear the timer 2 interrupt flag. */
#define portCLEAR_INTERRUPT_FLAG() TMR2CN &= ~0x80; #define portCLEAR_INTERRUPT_FLAG() TMR2CN &= ~0x80;
/* Used during a context switch to store the size of the stack being copied /* Used during a context switch to store the size of the stack being copied
to or from XRAM. */ to or from XRAM. */
@ -70,257 +70,257 @@ typedef void TCB_t;
extern volatile TCB_t * volatile pxCurrentTCB; extern volatile TCB_t * volatile pxCurrentTCB;
/* /*
* Setup the hardware to generate an interrupt off timer 2 at the required * Setup the hardware to generate an interrupt off timer 2 at the required
* frequency. * frequency.
*/ */
static void prvSetupTimerInterrupt( void ); static void prvSetupTimerInterrupt( void );
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
/* /*
* Macro that copies the current stack from internal RAM to XRAM. This is * Macro that copies the current stack from internal RAM to XRAM. This is
* required as the 8051 only contains enough internal RAM for a single stack, * required as the 8051 only contains enough internal RAM for a single stack,
* but we have a stack for every task. * but we have a stack for every task.
*/ */
#define portCOPY_STACK_TO_XRAM() \ #define portCOPY_STACK_TO_XRAM() \
{ \ { \
/* pxCurrentTCB points to a TCB which itself points to the location into \ /* pxCurrentTCB points to a TCB which itself points to the location into \
which the first stack byte should be copied. Set pxXRAMStack to point \ which the first stack byte should be copied. Set pxXRAMStack to point \
to the location into which the first stack byte is to be copied. */ \ to the location into which the first stack byte is to be copied. */ \
pxXRAMStack = ( xdata StackType_t * ) *( ( xdata StackType_t ** ) pxCurrentTCB ); \ pxXRAMStack = ( xdata StackType_t * ) *( ( xdata StackType_t ** ) pxCurrentTCB ); \
\ \
/* Set pxRAMStack to point to the first byte to be coped from the stack. */ \ /* Set pxRAMStack to point to the first byte to be coped from the stack. */ \
pxRAMStack = ( data StackType_t * data ) configSTACK_START; \ pxRAMStack = ( data StackType_t * data ) configSTACK_START; \
\ \
/* Calculate the size of the stack we are about to copy from the current \ /* Calculate the size of the stack we are about to copy from the current \
stack pointer value. */ \ stack pointer value. */ \
ucStackBytes = SP - ( configSTACK_START - 1 ); \ ucStackBytes = SP - ( configSTACK_START - 1 ); \
\ \
/* Before starting to copy the stack, store the calculated stack size so \ /* Before starting to copy the stack, store the calculated stack size so \
the stack can be restored when the task is resumed. */ \ the stack can be restored when the task is resumed. */ \
*pxXRAMStack = ucStackBytes; \ *pxXRAMStack = ucStackBytes; \
\ \
/* Copy each stack byte in turn. pxXRAMStack is incremented first as we \ /* Copy each stack byte in turn. pxXRAMStack is incremented first as we \
have already stored the stack size into XRAM. */ \ have already stored the stack size into XRAM. */ \
while( ucStackBytes ) \ while( ucStackBytes ) \
{ \ { \
pxXRAMStack++; \ pxXRAMStack++; \
*pxXRAMStack = *pxRAMStack; \ *pxXRAMStack = *pxRAMStack; \
pxRAMStack++; \ pxRAMStack++; \
ucStackBytes--; \ ucStackBytes--; \
} \ } \
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
/* /*
* Macro that copies the stack of the task being resumed from XRAM into * Macro that copies the stack of the task being resumed from XRAM into
* internal RAM. * internal RAM.
*/ */
#define portCOPY_XRAM_TO_STACK() \ #define portCOPY_XRAM_TO_STACK() \
{ \ { \
/* Setup the pointers as per portCOPY_STACK_TO_XRAM(), but this time to \ /* Setup the pointers as per portCOPY_STACK_TO_XRAM(), but this time to \
copy the data back out of XRAM and into the stack. */ \ copy the data back out of XRAM and into the stack. */ \
pxXRAMStack = ( xdata StackType_t * ) *( ( xdata StackType_t ** ) pxCurrentTCB ); \ pxXRAMStack = ( xdata StackType_t * ) *( ( xdata StackType_t ** ) pxCurrentTCB ); \
pxRAMStack = ( data StackType_t * data ) ( configSTACK_START - 1 ); \ pxRAMStack = ( data StackType_t * data ) ( configSTACK_START - 1 ); \
\ \
/* The first value stored in XRAM was the size of the stack - i.e. the \ /* The first value stored in XRAM was the size of the stack - i.e. the \
number of bytes we need to copy back. */ \ number of bytes we need to copy back. */ \
ucStackBytes = pxXRAMStack[ 0 ]; \ ucStackBytes = pxXRAMStack[ 0 ]; \
\ \
/* Copy the required number of bytes back into the stack. */ \ /* Copy the required number of bytes back into the stack. */ \
do \ do \
{ \ { \
pxXRAMStack++; \ pxXRAMStack++; \
pxRAMStack++; \ pxRAMStack++; \
*pxRAMStack = *pxXRAMStack; \ *pxRAMStack = *pxXRAMStack; \
ucStackBytes--; \ ucStackBytes--; \
} while( ucStackBytes ); \ } while( ucStackBytes ); \
\ \
/* Restore the stack pointer ready to use the restored stack. */ \ /* Restore the stack pointer ready to use the restored stack. */ \
SP = ( uint8_t ) pxRAMStack; \ SP = ( uint8_t ) pxRAMStack; \
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
/* /*
* Macro to push the current execution context onto the stack, before the stack * Macro to push the current execution context onto the stack, before the stack
* is moved to XRAM. * is moved to XRAM.
*/ */
#define portSAVE_CONTEXT() \ #define portSAVE_CONTEXT() \
{ \ { \
_asm \ _asm \
/* Push ACC first, as when restoring the context it must be restored \ /* Push ACC first, as when restoring the context it must be restored \
last (it is used to set the IE register). */ \ last (it is used to set the IE register). */ \
push ACC \ push ACC \
/* Store the IE register then disable interrupts. */ \ /* Store the IE register then disable interrupts. */ \
push IE \ push IE \
clr _EA \ clr _EA \
push DPL \ push DPL \
push DPH \ push DPH \
push b \ push b \
push ar2 \ push ar2 \
push ar3 \ push ar3 \
push ar4 \ push ar4 \
push ar5 \ push ar5 \
push ar6 \ push ar6 \
push ar7 \ push ar7 \
push ar0 \ push ar0 \
push ar1 \ push ar1 \
push PSW \ push PSW \
_endasm; \ _endasm; \
PSW = 0; \ PSW = 0; \
_asm \ _asm \
push _bp \ push _bp \
_endasm; \ _endasm; \
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
/* /*
* Macro that restores the execution context from the stack. The execution * Macro that restores the execution context from the stack. The execution
* context was saved into the stack before the stack was copied into XRAM. * context was saved into the stack before the stack was copied into XRAM.
*/ */
#define portRESTORE_CONTEXT() \ #define portRESTORE_CONTEXT() \
{ \ { \
_asm \ _asm \
pop _bp \ pop _bp \
pop PSW \ pop PSW \
pop ar1 \ pop ar1 \
pop ar0 \ pop ar0 \
pop ar7 \ pop ar7 \
pop ar6 \ pop ar6 \
pop ar5 \ pop ar5 \
pop ar4 \ pop ar4 \
pop ar3 \ pop ar3 \
pop ar2 \ pop ar2 \
pop b \ pop b \
pop DPH \ pop DPH \
pop DPL \ pop DPL \
/* The next byte of the stack is the IE register. Only the global \ /* The next byte of the stack is the IE register. Only the global \
enable bit forms part of the task context. Pop off the IE then set \ enable bit forms part of the task context. Pop off the IE then set \
the global enable bit to match that of the stored IE register. */ \ the global enable bit to match that of the stored IE register. */ \
pop ACC \ pop ACC \
JB ACC.7,0098$ \ JB ACC.7,0098$ \
CLR IE.7 \ CLR IE.7 \
LJMP 0099$ \ LJMP 0099$ \
0098$: \ 0098$: \
SETB IE.7 \ SETB IE.7 \
0099$: \ 0099$: \
/* Finally pop off the ACC, which was the first register saved. */ \ /* Finally pop off the ACC, which was the first register saved. */ \
pop ACC \ pop ACC \
reti \ reti \
_endasm; \ _endasm; \
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
/* /*
* See header file for description. * See header file for description.
*/ */
StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters ) StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )
{ {
uint32_t ulAddress; uint32_t ulAddress;
StackType_t *pxStartOfStack; StackType_t *pxStartOfStack;
/* Leave space to write the size of the stack as the first byte. */ /* Leave space to write the size of the stack as the first byte. */
pxStartOfStack = pxTopOfStack; pxStartOfStack = pxTopOfStack;
pxTopOfStack++; pxTopOfStack++;
/* Place a few bytes of known values on the bottom of the stack. /* Place a few bytes of known values on the bottom of the stack.
This is just useful for debugging and can be uncommented if required. This is just useful for debugging and can be uncommented if required.
*pxTopOfStack = 0x11; *pxTopOfStack = 0x11;
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x22; *pxTopOfStack = 0x22;
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x33; *pxTopOfStack = 0x33;
pxTopOfStack++; pxTopOfStack++;
*/ */
/* Simulate how the stack would look after a call to the scheduler tick /* Simulate how the stack would look after a call to the scheduler tick
ISR. ISR.
The return address that would have been pushed by the MCU. */ The return address that would have been pushed by the MCU. */
ulAddress = ( uint32_t ) pxCode; ulAddress = ( uint32_t ) pxCode;
*pxTopOfStack = ( StackType_t ) ulAddress; *pxTopOfStack = ( StackType_t ) ulAddress;
ulAddress >>= 8; ulAddress >>= 8;
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = ( StackType_t ) ( ulAddress ); *pxTopOfStack = ( StackType_t ) ( ulAddress );
pxTopOfStack++; pxTopOfStack++;
/* Next all the registers will have been pushed by portSAVE_CONTEXT(). */ /* Next all the registers will have been pushed by portSAVE_CONTEXT(). */
*pxTopOfStack = 0xaa; /* acc */ *pxTopOfStack = 0xaa; /* acc */
pxTopOfStack++; pxTopOfStack++;
/* We want tasks to start with interrupts enabled. */ /* We want tasks to start with interrupts enabled. */
*pxTopOfStack = portGLOBAL_INTERRUPT_BIT; *pxTopOfStack = portGLOBAL_INTERRUPT_BIT;
pxTopOfStack++; pxTopOfStack++;
/* The function parameters will be passed in the DPTR and B register as /* The function parameters will be passed in the DPTR and B register as
a three byte generic pointer is used. */ a three byte generic pointer is used. */
ulAddress = ( uint32_t ) pvParameters; ulAddress = ( uint32_t ) pvParameters;
*pxTopOfStack = ( StackType_t ) ulAddress; /* DPL */ *pxTopOfStack = ( StackType_t ) ulAddress; /* DPL */
ulAddress >>= 8; ulAddress >>= 8;
*pxTopOfStack++; *pxTopOfStack++;
*pxTopOfStack = ( StackType_t ) ulAddress; /* DPH */ *pxTopOfStack = ( StackType_t ) ulAddress; /* DPH */
ulAddress >>= 8; ulAddress >>= 8;
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = ( StackType_t ) ulAddress; /* b */ *pxTopOfStack = ( StackType_t ) ulAddress; /* b */
pxTopOfStack++; pxTopOfStack++;
/* The remaining registers are straight forward. */ /* The remaining registers are straight forward. */
*pxTopOfStack = 0x02; /* R2 */ *pxTopOfStack = 0x02; /* R2 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x03; /* R3 */ *pxTopOfStack = 0x03; /* R3 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x04; /* R4 */ *pxTopOfStack = 0x04; /* R4 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x05; /* R5 */ *pxTopOfStack = 0x05; /* R5 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x06; /* R6 */ *pxTopOfStack = 0x06; /* R6 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x07; /* R7 */ *pxTopOfStack = 0x07; /* R7 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x00; /* R0 */ *pxTopOfStack = 0x00; /* R0 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x01; /* R1 */ *pxTopOfStack = 0x01; /* R1 */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0x00; /* PSW */ *pxTopOfStack = 0x00; /* PSW */
pxTopOfStack++; pxTopOfStack++;
*pxTopOfStack = 0xbb; /* BP */ *pxTopOfStack = 0xbb; /* BP */
/* Dont increment the stack size here as we don't want to include /* Dont increment the stack size here as we don't want to include
the stack size byte as part of the stack size count. the stack size byte as part of the stack size count.
Finally we place the stack size at the beginning. */ Finally we place the stack size at the beginning. */
*pxStartOfStack = ( StackType_t ) ( pxTopOfStack - pxStartOfStack ); *pxStartOfStack = ( StackType_t ) ( pxTopOfStack - pxStartOfStack );
/* Unlike most ports, we return the start of the stack as this is where the /* Unlike most ports, we return the start of the stack as this is where the
size of the stack is stored. */ size of the stack is stored. */
return pxStartOfStack; return pxStartOfStack;
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
/* /*
* See header file for description. * See header file for description.
*/ */
BaseType_t xPortStartScheduler( void ) BaseType_t xPortStartScheduler( void )
{ {
/* Setup timer 2 to generate the RTOS tick. */ /* Setup timer 2 to generate the RTOS tick. */
prvSetupTimerInterrupt(); prvSetupTimerInterrupt();
/* Make sure we start with the expected SFR page. This line should not /* Make sure we start with the expected SFR page. This line should not
really be required. */ really be required. */
SFRPAGE = 0; SFRPAGE = 0;
/* Copy the stack for the first task to execute from XRAM into the stack, /* Copy the stack for the first task to execute from XRAM into the stack,
restore the task context from the new stack, then start running the task. */ restore the task context from the new stack, then start running the task. */
portCOPY_XRAM_TO_STACK(); portCOPY_XRAM_TO_STACK();
portRESTORE_CONTEXT(); portRESTORE_CONTEXT();
/* Should never get here! */ /* Should never get here! */
return pdTRUE; return pdTRUE;
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
void vPortEndScheduler( void ) void vPortEndScheduler( void )
{ {
/* Not implemented for this port. */ /* Not implemented for this port. */
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
@ -330,53 +330,53 @@ void vPortEndScheduler( void )
*/ */
void vPortYield( void ) _naked void vPortYield( void ) _naked
{ {
/* Save the execution context onto the stack, then copy the entire stack /* Save the execution context onto the stack, then copy the entire stack
to XRAM. This is necessary as the internal RAM is only large enough to to XRAM. This is necessary as the internal RAM is only large enough to
hold one stack, and we want one per task. hold one stack, and we want one per task.
PERFORMANCE COULD BE IMPROVED BY ONLY COPYING TO XRAM IF A TASK SWITCH
IS REQUIRED. */
portSAVE_CONTEXT();
portCOPY_STACK_TO_XRAM();
/* Call the standard scheduler context switch function. */ PERFORMANCE COULD BE IMPROVED BY ONLY COPYING TO XRAM IF A TASK SWITCH
vTaskSwitchContext(); IS REQUIRED. */
portSAVE_CONTEXT();
portCOPY_STACK_TO_XRAM();
/* Copy the stack of the task about to execute from XRAM into RAM and /* Call the standard scheduler context switch function. */
restore it's context ready to run on exiting. */ vTaskSwitchContext();
portCOPY_XRAM_TO_STACK();
portRESTORE_CONTEXT(); /* Copy the stack of the task about to execute from XRAM into RAM and
restore it's context ready to run on exiting. */
portCOPY_XRAM_TO_STACK();
portRESTORE_CONTEXT();
} }
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
#if configUSE_PREEMPTION == 1 #if configUSE_PREEMPTION == 1
void vTimer2ISR( void ) interrupt 5 _naked void vTimer2ISR( void ) interrupt 5 _naked
{ {
/* Preemptive context switch function triggered by the timer 2 ISR. /* Preemptive context switch function triggered by the timer 2 ISR.
This does the same as vPortYield() (see above) with the addition This does the same as vPortYield() (see above) with the addition
of incrementing the RTOS tick count. */ of incrementing the RTOS tick count. */
portSAVE_CONTEXT(); portSAVE_CONTEXT();
portCOPY_STACK_TO_XRAM(); portCOPY_STACK_TO_XRAM();
if( xTaskIncrementTick() != pdFALSE ) if( xTaskIncrementTick() != pdFALSE )
{ {
vTaskSwitchContext(); vTaskSwitchContext();
} }
portCLEAR_INTERRUPT_FLAG(); portCLEAR_INTERRUPT_FLAG();
portCOPY_XRAM_TO_STACK(); portCOPY_XRAM_TO_STACK();
portRESTORE_CONTEXT(); portRESTORE_CONTEXT();
} }
#else #else
void vTimer2ISR( void ) interrupt 5 void vTimer2ISR( void ) interrupt 5
{ {
/* When using the cooperative scheduler the timer 2 ISR is only /* When using the cooperative scheduler the timer 2 ISR is only
required to increment the RTOS tick count. */ required to increment the RTOS tick count. */
xTaskIncrementTick(); xTaskIncrementTick();
portCLEAR_INTERRUPT_FLAG(); portCLEAR_INTERRUPT_FLAG();
} }
#endif #endif
/*-----------------------------------------------------------*/ /*-----------------------------------------------------------*/
@ -391,33 +391,33 @@ const uint32_t ulCaptureValue = portMAX_TIMER_VALUE - ulCaptureTime;
const uint8_t ucLowCaptureByte = ( uint8_t ) ( ulCaptureValue & ( uint32_t ) 0xff ); const uint8_t ucLowCaptureByte = ( uint8_t ) ( ulCaptureValue & ( uint32_t ) 0xff );
const uint8_t ucHighCaptureByte = ( uint8_t ) ( ulCaptureValue >> ( uint32_t ) 8 ); const uint8_t ucHighCaptureByte = ( uint8_t ) ( ulCaptureValue >> ( uint32_t ) 8 );
/* NOTE: This uses a timer only present on 8052 architecture. */ /* NOTE: This uses a timer only present on 8052 architecture. */
/* Remember the current SFR page so we can restore it at the end of the /* Remember the current SFR page so we can restore it at the end of the
function. */ function. */
ucOriginalSFRPage = SFRPAGE; ucOriginalSFRPage = SFRPAGE;
SFRPAGE = 0; SFRPAGE = 0;
/* TMR2CF can be left in its default state. */ /* TMR2CF can be left in its default state. */
TMR2CF = ( uint8_t ) 0; TMR2CF = ( uint8_t ) 0;
/* Setup the overflow reload value. */ /* Setup the overflow reload value. */
RCAP2L = ucLowCaptureByte; RCAP2L = ucLowCaptureByte;
RCAP2H = ucHighCaptureByte; RCAP2H = ucHighCaptureByte;
/* The initial load is performed manually. */ /* The initial load is performed manually. */
TMR2L = ucLowCaptureByte; TMR2L = ucLowCaptureByte;
TMR2H = ucHighCaptureByte; TMR2H = ucHighCaptureByte;
/* Enable the timer 2 interrupts. */ /* Enable the timer 2 interrupts. */
IE |= portTIMER_2_INTERRUPT_ENABLE; IE |= portTIMER_2_INTERRUPT_ENABLE;
/* Interrupts are disabled when this is called so the timer can be started /* Interrupts are disabled when this is called so the timer can be started
here. */ here. */
TMR2CN = portENABLE_TIMER; TMR2CN = portENABLE_TIMER;
/* Restore the original SFR page. */ /* Restore the original SFR page. */
SFRPAGE = ucOriginalSFRPage; SFRPAGE = ucOriginalSFRPage;
} }