From 546990788d1836cb72edec0799b49d5a4695f596 Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Sat, 28 May 2011 17:28:21 +0100 Subject: [PATCH 1/8] Use info@atomthreads.com email address throughout documentation. --- README | 2 +- kernel/README | 20 ++++++++++---------- ports/avr/README | 2 +- ports/stm8/README-COSMIC | 2 +- ports/stm8/README-IAR | 2 +- ports/stm8/README-RAISONANCE | 2 +- tests/README | 22 +++++++++++----------- 7 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README b/README index 79ab9b2..b88b6b4 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- Library: Atomthreads -Author: Kelvin Lawson +Author: Kelvin Lawson Website: http://atomthreads.com License: BSD Revised diff --git a/kernel/README b/kernel/README index 3d33f3f..ecec7d4 100644 --- a/kernel/README +++ b/kernel/README @@ -1,11 +1,11 @@ ---------------------------------------------------------------------------- - -Library: Atomthreads -Author: Kelvin Lawson -Website: http://atomthreads.com -License: BSD Revised - ---------------------------------------------------------------------------- +--------------------------------------------------------------------------- + +Library: Atomthreads +Author: Kelvin Lawson +Website: http://atomthreads.com +License: BSD Revised + +--------------------------------------------------------------------------- KERNEL SOURCES @@ -21,12 +21,12 @@ Each module source file contains detailed documentation including an introduction to usage of the module and full descriptions of each API. Refer to the sources for further documentation. ---------------------------------------------------------------------------- +--------------------------------------------------------------------------- BUILDING THE KERNEL The kernel is built from the architecture port folder. Build instructions are included in the README file for each port. ---------------------------------------------------------------------------- +--------------------------------------------------------------------------- diff --git a/ports/avr/README b/ports/avr/README index df61880..e73fa4c 100644 --- a/ports/avr/README +++ b/ports/avr/README @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- Library: Atomthreads -Author: Kelvin Lawson +Author: Kelvin Lawson Website: http://atomthreads.com License: BSD Revised diff --git a/ports/stm8/README-COSMIC b/ports/stm8/README-COSMIC index cae78f3..94e2bc5 100644 --- a/ports/stm8/README-COSMIC +++ b/ports/stm8/README-COSMIC @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- Library: Atomthreads -Author: Kelvin Lawson +Author: Kelvin Lawson Website: http://atomthreads.com License: BSD Revised diff --git a/ports/stm8/README-IAR b/ports/stm8/README-IAR index 9e82acd..9225e07 100644 --- a/ports/stm8/README-IAR +++ b/ports/stm8/README-IAR @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- Library: Atomthreads -Author: Kelvin Lawson +Author: Kelvin Lawson Website: http://atomthreads.com License: BSD Revised diff --git a/ports/stm8/README-RAISONANCE b/ports/stm8/README-RAISONANCE index 8eef2cd..c99b90c 100644 --- a/ports/stm8/README-RAISONANCE +++ b/ports/stm8/README-RAISONANCE @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- Library: Atomthreads -Author: Kelvin Lawson +Author: Kelvin Lawson Website: http://atomthreads.com License: BSD Revised diff --git a/tests/README b/tests/README index e343a7a..35c23a7 100644 --- a/tests/README +++ b/tests/README @@ -1,11 +1,11 @@ ---------------------------------------------------------------------------- - -Library: Atomthreads -Author: Kelvin Lawson -Website: http://atomthreads.com -License: BSD Revised - ---------------------------------------------------------------------------- +--------------------------------------------------------------------------- + +Library: Atomthreads +Author: Kelvin Lawson +Website: http://atomthreads.com +License: BSD Revised + +--------------------------------------------------------------------------- AUTOMATED TEST SUITE @@ -20,7 +20,7 @@ Developers of new CPU architecture ports can take advantage of the thorough coverage provided by these tests to considerably speed up development and validation time. ---------------------------------------------------------------------------- +--------------------------------------------------------------------------- HOW TO RUN THE TESTS @@ -29,7 +29,7 @@ folder. Instructions are included in the README file for each port, which describes the process for building test applications as well as downloading to and running the tests on the target device. ---------------------------------------------------------------------------- +--------------------------------------------------------------------------- WRITING ADDITIONAL TESTS @@ -50,5 +50,5 @@ modules which do not consume large amounts of processor resource. For example the number of test threads should ideally be kept low in order to allow smaller systems to accommodate the thread stack requirements. ---------------------------------------------------------------------------- +--------------------------------------------------------------------------- From fae8dd7516eb43111736079b7884519136a044ee Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Thu, 2 Jun 2011 22:12:56 +0100 Subject: [PATCH 2/8] Formatting changes only. --- ports/avr/tests-main.c | 4 ++-- ports/stm8/tests-main.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ports/avr/tests-main.c b/ports/avr/tests-main.c index 9cb5596..a634167 100644 --- a/ports/avr/tests-main.c +++ b/ports/avr/tests-main.c @@ -245,7 +245,7 @@ static void main_thread_func (uint32_t data) stdout = &uart_stdout; /* Put a message out on the UART */ - printf_P(PSTR("Go\n")); + printf_P (PSTR("Go\n")); /* Start test. All tests use the same start API. */ test_status = test_start(); @@ -295,7 +295,7 @@ static void main_thread_func (uint32_t data) PORTB ^= (1 << 7); /* Sleep then toggle LED again */ - atomTimerDelay(sleep_ticks); + atomTimerDelay (sleep_ticks); } } diff --git a/ports/stm8/tests-main.c b/ports/stm8/tests-main.c index 21b6d4d..6b24bf2 100644 --- a/ports/stm8/tests-main.c +++ b/ports/stm8/tests-main.c @@ -201,7 +201,7 @@ static void main_thread_func (uint32_t param) } /* Put a message out on the UART */ - printf("Go\n"); + printf ("Go\n"); /* Start test. All tests use the same start API. */ test_status = test_start(); @@ -255,7 +255,7 @@ static void main_thread_func (uint32_t param) GPIO_WriteReverse(GPIOD, GPIO_PIN_0); /* Sleep then toggle LED again */ - atomTimerDelay(sleep_ticks); + atomTimerDelay (sleep_ticks); } } From 7bc40f9d62029540bc30d1870a29fe34fba77e32 Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Thu, 2 Jun 2011 22:23:57 +0100 Subject: [PATCH 3/8] Formatting changes. --- ports/avr/tests-main.c | 2 +- ports/stm8/tests-main.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/ports/avr/tests-main.c b/ports/avr/tests-main.c index a634167..c8c9abb 100644 --- a/ports/avr/tests-main.c +++ b/ports/avr/tests-main.c @@ -186,7 +186,7 @@ int main ( void ) TEST_THREAD_PRIO, main_thread_func, 0, &main_thread_stack[0], MAIN_STACK_SIZE_BYTES, - TRUE); + TRUE); if (status == ATOM_OK) { /** diff --git a/ports/stm8/tests-main.c b/ports/stm8/tests-main.c index 6b24bf2..7981a19 100644 --- a/ports/stm8/tests-main.c +++ b/ports/stm8/tests-main.c @@ -150,7 +150,7 @@ NO_REG_SAVE void main ( void ) TEST_THREAD_PRIO, main_thread_func, 0, &main_thread_stack[0], MAIN_STACK_SIZE_BYTES, - TRUE); + TRUE); if (status == ATOM_OK) { /** From ac0643a9598c2158a0f9b9033dc53c43164a7afa Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Thu, 2 Jun 2011 22:32:49 +0100 Subject: [PATCH 4/8] First draft of MIPS port from Himanshu. Some local mods to more closely resemble the headers and layout of the AVR and STM8 ports. --- ports/mips/.gdbinit | 1 + ports/mips/8250-serial.c | 74 ++ ports/mips/8250-serial.h | 346 +++++++++ ports/mips/Doxyfile | 1161 ++++++++++++++++++++++++++++++ ports/mips/Makefile | 140 ++++ ports/mips/README | 3 + ports/mips/atomport-asm-macros.h | 283 ++++++++ ports/mips/atomport-asm.s | 186 +++++ ports/mips/atomport-entry.s | 161 +++++ ports/mips/atomport-interrupts.c | 58 ++ ports/mips/atomport-interrupts.h | 38 + ports/mips/atomport-private.h | 36 + ports/mips/atomport-tests.h | 51 ++ ports/mips/atomport-timer.c | 67 ++ ports/mips/atomport.c | 82 +++ ports/mips/atomport.h | 96 +++ ports/mips/io.c | 44 ++ ports/mips/linker.ld | 74 ++ ports/mips/printk.c | 59 ++ ports/mips/printk.h | 42 ++ ports/mips/regs.h | 144 ++++ ports/mips/stdarg.h | 28 + ports/mips/string.c | 61 ++ ports/mips/string.h | 42 ++ ports/mips/system.h | 52 ++ ports/mips/tests-main.c | 260 +++++++ ports/mips/vsprintf.c | 244 +++++++ 27 files changed, 3833 insertions(+) create mode 100644 ports/mips/.gdbinit create mode 100644 ports/mips/8250-serial.c create mode 100644 ports/mips/8250-serial.h create mode 100644 ports/mips/Doxyfile create mode 100644 ports/mips/Makefile create mode 100644 ports/mips/README create mode 100644 ports/mips/atomport-asm-macros.h create mode 100644 ports/mips/atomport-asm.s create mode 100644 ports/mips/atomport-entry.s create mode 100644 ports/mips/atomport-interrupts.c create mode 100644 ports/mips/atomport-interrupts.h create mode 100644 ports/mips/atomport-private.h create mode 100644 ports/mips/atomport-tests.h create mode 100644 ports/mips/atomport-timer.c create mode 100644 ports/mips/atomport.c create mode 100644 ports/mips/atomport.h create mode 100644 ports/mips/io.c create mode 100755 ports/mips/linker.ld create mode 100644 ports/mips/printk.c create mode 100644 ports/mips/printk.h create mode 100644 ports/mips/regs.h create mode 100755 ports/mips/stdarg.h create mode 100644 ports/mips/string.c create mode 100644 ports/mips/string.h create mode 100644 ports/mips/system.h create mode 100644 ports/mips/tests-main.c create mode 100644 ports/mips/vsprintf.c diff --git a/ports/mips/.gdbinit b/ports/mips/.gdbinit new file mode 100644 index 0000000..24efe1e --- /dev/null +++ b/ports/mips/.gdbinit @@ -0,0 +1 @@ +target remote localhost:1234 diff --git a/ports/mips/8250-serial.c b/ports/mips/8250-serial.c new file mode 100644 index 0000000..8d155dd --- /dev/null +++ b/ports/mips/8250-serial.c @@ -0,0 +1,74 @@ +/* + * Copyright (c) Himanshu Chauhan 2009-11. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#include +#include +#include <8250-serial.h> + +#define PORT1 (void *)0xc00003f8 + +static inline unsigned int serial_in(int offset) +{ + return ioreadb(PORT1 + offset); +} + +static inline void serial_out(int offset, int value) +{ + iowriteb(PORT1 + offset, value); +} + +void putch(uint8_t c) +{ + while ((serial_in(UART_LSR) & UART_LSR_THRE) == 0) + ; + + serial_out(UART_TX, c); +} + +void init_console() +{ + serial_out(1 , 0); /* Turn off interrupts */ + + /* Communication Settings */ + serial_out(3 , 0x80); /* SET DLAB ON */ + serial_out(0 , 0x01); /* Set Baud rate - Divisor Latch Low Byte */ + /* 0x03 = 38,400 BPS */ + /* Default 0x01 = 115,200 BPS */ + /* 0x02 = 57,600 BPS */ + /* 0x06 = 19,200 BPS */ + /* 0x0C = 9,600 BPS */ + /* 0x18 = 4,800 BPS */ + /* 0x30 = 2,400 BPS */ + serial_out(1 , 0x00); /* Set Baud rate - Divisor Latch High Byte */ + serial_out(3 , 0x03); /* 8 Bits, No Parity, 1 Stop Bit */ + serial_out(2 , 0xC7); /* FIFO Control Register */ + serial_out(4 , 0x0B); /* Turn on DTR, RTS, and OUT2 */ +} diff --git a/ports/mips/8250-serial.h b/ports/mips/8250-serial.h new file mode 100644 index 0000000..c7907a1 --- /dev/null +++ b/ports/mips/8250-serial.h @@ -0,0 +1,346 @@ +/* + * Copyright (c) Himanshu Chauhan 2009-11. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#ifndef _8250_SERIAL_H +#define _8250_SERIAL_H + +/* + * DLAB=0 + */ +#define UART_RX 0 /* In: Receive buffer */ +#define UART_TX 0 /* Out: Transmit buffer */ + +#define UART_IER 1 /* Out: Interrupt Enable Register */ +#define UART_IER_MSI 0x08 /* Enable Modem status interrupt */ +#define UART_IER_RLSI 0x04 /* Enable receiver line status interrupt */ +#define UART_IER_THRI 0x02 /* Enable Transmitter holding register int. */ +#define UART_IER_RDI 0x01 /* Enable receiver data interrupt */ +/* + * Sleep mode for ST16650 and TI16750. For the ST16650, EFR[4]=1 + */ +#define UART_IERX_SLEEP 0x10 /* Enable sleep mode */ + +#define UART_IIR 2 /* In: Interrupt ID Register */ +#define UART_IIR_NO_INT 0x01 /* No interrupts pending */ +#define UART_IIR_ID 0x06 /* Mask for the interrupt ID */ +#define UART_IIR_MSI 0x00 /* Modem status interrupt */ +#define UART_IIR_THRI 0x02 /* Transmitter holding register empty */ +#define UART_IIR_RDI 0x04 /* Receiver data interrupt */ +#define UART_IIR_RLSI 0x06 /* Receiver line status interrupt */ + +#define UART_IIR_BUSY 0x07 /* DesignWare APB Busy Detect */ + +#define UART_FCR 2 /* Out: FIFO Control Register */ +#define UART_FCR_ENABLE_FIFO 0x01 /* Enable the FIFO */ +#define UART_FCR_CLEAR_RCVR 0x02 /* Clear the RCVR FIFO */ +#define UART_FCR_CLEAR_XMIT 0x04 /* Clear the XMIT FIFO */ +#define UART_FCR_DMA_SELECT 0x08 /* For DMA applications */ +/* + * Note: The FIFO trigger levels are chip specific: + * RX:76 = 00 01 10 11 TX:54 = 00 01 10 11 + * PC16550D: 1 4 8 14 xx xx xx xx + * TI16C550A: 1 4 8 14 xx xx xx xx + * TI16C550C: 1 4 8 14 xx xx xx xx + * ST16C550: 1 4 8 14 xx xx xx xx + * ST16C650: 8 16 24 28 16 8 24 30 PORT_16650V2 + * NS16C552: 1 4 8 14 xx xx xx xx + * ST16C654: 8 16 56 60 8 16 32 56 PORT_16654 + * TI16C750: 1 16 32 56 xx xx xx xx PORT_16750 + * TI16C752: 8 16 56 60 8 16 32 56 + */ +#define UART_FCR_R_TRIG_00 0x00 +#define UART_FCR_R_TRIG_01 0x40 +#define UART_FCR_R_TRIG_10 0x80 +#define UART_FCR_R_TRIG_11 0xc0 +#define UART_FCR_T_TRIG_00 0x00 +#define UART_FCR_T_TRIG_01 0x10 +#define UART_FCR_T_TRIG_10 0x20 +#define UART_FCR_T_TRIG_11 0x30 + +#define UART_FCR_TRIGGER_MASK 0xC0 /* Mask for the FIFO trigger range */ +#define UART_FCR_TRIGGER_1 0x00 /* Mask for trigger set at 1 */ +#define UART_FCR_TRIGGER_4 0x40 /* Mask for trigger set at 4 */ +#define UART_FCR_TRIGGER_8 0x80 /* Mask for trigger set at 8 */ +#define UART_FCR_TRIGGER_14 0xC0 /* Mask for trigger set at 14 */ +/* 16650 definitions */ +#define UART_FCR6_R_TRIGGER_8 0x00 /* Mask for receive trigger set at 1 */ +#define UART_FCR6_R_TRIGGER_16 0x40 /* Mask for receive trigger set at 4 */ +#define UART_FCR6_R_TRIGGER_24 0x80 /* Mask for receive trigger set at 8 */ +#define UART_FCR6_R_TRIGGER_28 0xC0 /* Mask for receive trigger set at 14 */ +#define UART_FCR6_T_TRIGGER_16 0x00 /* Mask for transmit trigger set at 16 */ +#define UART_FCR6_T_TRIGGER_8 0x10 /* Mask for transmit trigger set at 8 */ +#define UART_FCR6_T_TRIGGER_24 0x20 /* Mask for transmit trigger set at 24 */ +#define UART_FCR6_T_TRIGGER_30 0x30 /* Mask for transmit trigger set at 30 */ +#define UART_FCR7_64BYTE 0x20 /* Go into 64 byte mode (TI16C750) */ + +#define UART_LCR 3 /* Out: Line Control Register */ +/* + * Note: if the word length is 5 bits (UART_LCR_WLEN5), then setting + * UART_LCR_STOP will select 1.5 stop bits, not 2 stop bits. + */ +#define UART_LCR_DLAB 0x80 /* Divisor latch access bit */ +#define UART_LCR_SBC 0x40 /* Set break control */ +#define UART_LCR_SPAR 0x20 /* Stick parity (?) */ +#define UART_LCR_EPAR 0x10 /* Even parity select */ +#define UART_LCR_PARITY 0x08 /* Parity Enable */ +#define UART_LCR_STOP 0x04 /* Stop bits: 0=1 bit, 1=2 bits */ +#define UART_LCR_WLEN5 0x00 /* Wordlength: 5 bits */ +#define UART_LCR_WLEN6 0x01 /* Wordlength: 6 bits */ +#define UART_LCR_WLEN7 0x02 /* Wordlength: 7 bits */ +#define UART_LCR_WLEN8 0x03 /* Wordlength: 8 bits */ + +#define UART_MCR 4 /* Out: Modem Control Register */ +#define UART_MCR_CLKSEL 0x80 /* Divide clock by 4 (TI16C752, EFR[4]=1) */ +#define UART_MCR_TCRTLR 0x40 /* Access TCR/TLR (TI16C752, EFR[4]=1) */ +#define UART_MCR_XONANY 0x20 /* Enable Xon Any (TI16C752, EFR[4]=1) */ +#define UART_MCR_AFE 0x20 /* Enable auto-RTS/CTS (TI16C550C/TI16C750) */ +#define UART_MCR_LOOP 0x10 /* Enable loopback test mode */ +#define UART_MCR_OUT2 0x08 /* Out2 complement */ +#define UART_MCR_OUT1 0x04 /* Out1 complement */ +#define UART_MCR_RTS 0x02 /* RTS complement */ +#define UART_MCR_DTR 0x01 /* DTR complement */ + +#define UART_LSR 5 /* In: Line Status Register */ +#define UART_LSR_TEMT 0x40 /* Transmitter empty */ +#define UART_LSR_THRE 0x20 /* Transmit-hold-register empty */ +#define UART_LSR_BI 0x10 /* Break interrupt indicator */ +#define UART_LSR_FE 0x08 /* Frame error indicator */ +#define UART_LSR_PE 0x04 /* Parity error indicator */ +#define UART_LSR_OE 0x02 /* Overrun error indicator */ +#define UART_LSR_DR 0x01 /* Receiver data ready */ +#define UART_LSR_BRK_ERROR_BITS 0x1E /* BI, FE, PE, OE bits */ + +#define UART_MSR 6 /* In: Modem Status Register */ +#define UART_MSR_DCD 0x80 /* Data Carrier Detect */ +#define UART_MSR_RI 0x40 /* Ring Indicator */ +#define UART_MSR_DSR 0x20 /* Data Set Ready */ +#define UART_MSR_CTS 0x10 /* Clear to Send */ +#define UART_MSR_DDCD 0x08 /* Delta DCD */ +#define UART_MSR_TERI 0x04 /* Trailing edge ring indicator */ +#define UART_MSR_DDSR 0x02 /* Delta DSR */ +#define UART_MSR_DCTS 0x01 /* Delta CTS */ +#define UART_MSR_ANY_DELTA 0x0F /* Any of the delta bits! */ + +#define UART_SCR 7 /* I/O: Scratch Register */ + +/* + * DLAB=1 + */ +#define UART_DLL 0 /* Out: Divisor Latch Low */ +#define UART_DLM 1 /* Out: Divisor Latch High */ + +/* + * LCR=0xBF (or DLAB=1 for 16C660) + */ +#define UART_EFR 2 /* I/O: Extended Features Register */ +#define UART_EFR_CTS 0x80 /* CTS flow control */ +#define UART_EFR_RTS 0x40 /* RTS flow control */ +#define UART_EFR_SCD 0x20 /* Special character detect */ +#define UART_EFR_ECB 0x10 /* Enhanced control bit */ +/* + * the low four bits control software flow control + */ + +/* + * LCR=0xBF, TI16C752, ST16650, ST16650A, ST16654 + */ +#define UART_XON1 4 /* I/O: Xon character 1 */ +#define UART_XON2 5 /* I/O: Xon character 2 */ +#define UART_XOFF1 6 /* I/O: Xoff character 1 */ +#define UART_XOFF2 7 /* I/O: Xoff character 2 */ + +/* + * EFR[4]=1 MCR[6]=1, TI16C752 + */ +#define UART_TI752_TCR 6 /* I/O: transmission control register */ +#define UART_TI752_TLR 7 /* I/O: trigger level register */ + +/* + * LCR=0xBF, XR16C85x + */ +#define UART_TRG 0 /* FCTR bit 7 selects Rx or Tx + * In: Fifo count + * Out: Fifo custom trigger levels */ +/* + * These are the definitions for the Programmable Trigger Register + */ +#define UART_TRG_1 0x01 +#define UART_TRG_4 0x04 +#define UART_TRG_8 0x08 +#define UART_TRG_16 0x10 +#define UART_TRG_32 0x20 +#define UART_TRG_64 0x40 +#define UART_TRG_96 0x60 +#define UART_TRG_120 0x78 +#define UART_TRG_128 0x80 + +#define UART_FCTR 1 /* Feature Control Register */ +#define UART_FCTR_RTS_NODELAY 0x00 /* RTS flow control delay */ +#define UART_FCTR_RTS_4DELAY 0x01 +#define UART_FCTR_RTS_6DELAY 0x02 +#define UART_FCTR_RTS_8DELAY 0x03 +#define UART_FCTR_IRDA 0x04 /* IrDa data encode select */ +#define UART_FCTR_TX_INT 0x08 /* Tx interrupt type select */ +#define UART_FCTR_TRGA 0x00 /* Tx/Rx 550 trigger table select */ +#define UART_FCTR_TRGB 0x10 /* Tx/Rx 650 trigger table select */ +#define UART_FCTR_TRGC 0x20 /* Tx/Rx 654 trigger table select */ +#define UART_FCTR_TRGD 0x30 /* Tx/Rx 850 programmable trigger select */ +#define UART_FCTR_SCR_SWAP 0x40 /* Scratch pad register swap */ +#define UART_FCTR_RX 0x00 /* Programmable trigger mode select */ +#define UART_FCTR_TX 0x80 /* Programmable trigger mode select */ + +/* + * LCR=0xBF, FCTR[6]=1 + */ +#define UART_EMSR 7 /* Extended Mode Select Register */ +#define UART_EMSR_FIFO_COUNT 0x01 /* Rx/Tx select */ +#define UART_EMSR_ALT_COUNT 0x02 /* Alternating count select */ + +/* + * The Intel XScale on-chip UARTs define these bits + */ +#define UART_IER_DMAE 0x80 /* DMA Requests Enable */ +#define UART_IER_UUE 0x40 /* UART Unit Enable */ +#define UART_IER_NRZE 0x20 /* NRZ coding Enable */ +#define UART_IER_RTOIE 0x10 /* Receiver Time Out Interrupt Enable */ + +#define UART_IIR_TOD 0x08 /* Character Timeout Indication Detected */ + +#define UART_FCR_PXAR1 0x00 /* receive FIFO threshold = 1 */ +#define UART_FCR_PXAR8 0x40 /* receive FIFO threshold = 8 */ +#define UART_FCR_PXAR16 0x80 /* receive FIFO threshold = 16 */ +#define UART_FCR_PXAR32 0xc0 /* receive FIFO threshold = 32 */ + + + + +/* + * These register definitions are for the 16C950 + */ +#define UART_ASR 0x01 /* Additional Status Register */ +#define UART_RFL 0x03 /* Receiver FIFO level */ +#define UART_TFL 0x04 /* Transmitter FIFO level */ +#define UART_ICR 0x05 /* Index Control Register */ + +/* The 16950 ICR registers */ +#define UART_ACR 0x00 /* Additional Control Register */ +#define UART_CPR 0x01 /* Clock Prescalar Register */ +#define UART_TCR 0x02 /* Times Clock Register */ +#define UART_CKS 0x03 /* Clock Select Register */ +#define UART_TTL 0x04 /* Transmitter Interrupt Trigger Level */ +#define UART_RTL 0x05 /* Receiver Interrupt Trigger Level */ +#define UART_FCL 0x06 /* Flow Control Level Lower */ +#define UART_FCH 0x07 /* Flow Control Level Higher */ +#define UART_ID1 0x08 /* ID #1 */ +#define UART_ID2 0x09 /* ID #2 */ +#define UART_ID3 0x0A /* ID #3 */ +#define UART_REV 0x0B /* Revision */ +#define UART_CSR 0x0C /* Channel Software Reset */ +#define UART_NMR 0x0D /* Nine-bit Mode Register */ +#define UART_CTR 0xFF + +/* + * The 16C950 Additional Control Register + */ +#define UART_ACR_RXDIS 0x01 /* Receiver disable */ +#define UART_ACR_TXDIS 0x02 /* Transmitter disable */ +#define UART_ACR_DSRFC 0x04 /* DSR Flow Control */ +#define UART_ACR_TLENB 0x20 /* 950 trigger levels enable */ +#define UART_ACR_ICRRD 0x40 /* ICR Read enable */ +#define UART_ACR_ASREN 0x80 /* Additional status enable */ + + + +/* + * These definitions are for the RSA-DV II/S card, from + * + * Kiyokazu SUTO + */ + +#define UART_RSA_BASE (-8) + +#define UART_RSA_MSR ((UART_RSA_BASE) + 0) /* I/O: Mode Select Register */ + +#define UART_RSA_MSR_SWAP (1 << 0) /* Swap low/high 8 bytes in I/O port addr */ +#define UART_RSA_MSR_FIFO (1 << 2) /* Enable the external FIFO */ +#define UART_RSA_MSR_FLOW (1 << 3) /* Enable the auto RTS/CTS flow control */ +#define UART_RSA_MSR_ITYP (1 << 4) /* Level (1) / Edge triger (0) */ + +#define UART_RSA_IER ((UART_RSA_BASE) + 1) /* I/O: Interrupt Enable Register */ + +#define UART_RSA_IER_Rx_FIFO_H (1 << 0) /* Enable Rx FIFO half full int. */ +#define UART_RSA_IER_Tx_FIFO_H (1 << 1) /* Enable Tx FIFO half full int. */ +#define UART_RSA_IER_Tx_FIFO_E (1 << 2) /* Enable Tx FIFO empty int. */ +#define UART_RSA_IER_Rx_TOUT (1 << 3) /* Enable char receive timeout int */ +#define UART_RSA_IER_TIMER (1 << 4) /* Enable timer interrupt */ + +#define UART_RSA_SRR ((UART_RSA_BASE) + 2) /* IN: Status Read Register */ + +#define UART_RSA_SRR_Tx_FIFO_NEMP (1 << 0) /* Tx FIFO is not empty (1) */ +#define UART_RSA_SRR_Tx_FIFO_NHFL (1 << 1) /* Tx FIFO is not half full (1) */ +#define UART_RSA_SRR_Tx_FIFO_NFUL (1 << 2) /* Tx FIFO is not full (1) */ +#define UART_RSA_SRR_Rx_FIFO_NEMP (1 << 3) /* Rx FIFO is not empty (1) */ +#define UART_RSA_SRR_Rx_FIFO_NHFL (1 << 4) /* Rx FIFO is not half full (1) */ +#define UART_RSA_SRR_Rx_FIFO_NFUL (1 << 5) /* Rx FIFO is not full (1) */ +#define UART_RSA_SRR_Rx_TOUT (1 << 6) /* Character reception timeout occurred (1) */ +#define UART_RSA_SRR_TIMER (1 << 7) /* Timer interrupt occurred */ + +#define UART_RSA_FRR ((UART_RSA_BASE) + 2) /* OUT: FIFO Reset Register */ + +#define UART_RSA_TIVSR ((UART_RSA_BASE) + 3) /* I/O: Timer Interval Value Set Register */ + +#define UART_RSA_TCR ((UART_RSA_BASE) + 4) /* OUT: Timer Control Register */ + +#define UART_RSA_TCR_SWITCH (1 << 0) /* Timer on */ + +/* + * The RSA DSV/II board has two fixed clock frequencies. One is the + * standard rate, and the other is 8 times faster. + */ +#define SERIAL_RSA_BAUD_BASE (921600) +#define SERIAL_RSA_BAUD_BASE_LO (SERIAL_RSA_BAUD_BASE / 8) + +/* + * Extra serial register definitions for the internal UARTs + * in TI OMAP processors. + */ +#define UART_OMAP_MDR1 0x08 /* Mode definition register */ +#define UART_OMAP_MDR2 0x09 /* Mode definition register 2 */ +#define UART_OMAP_SCR 0x10 /* Supplementary control register */ +#define UART_OMAP_SSR 0x11 /* Supplementary status register */ +#define UART_OMAP_EBLR 0x12 /* BOF length register */ +#define UART_OMAP_OSC_12M_SEL 0x13 /* OMAP1510 12MHz osc select */ +#define UART_OMAP_MVER 0x14 /* Module version register */ +#define UART_OMAP_SYSC 0x15 /* System configuration register */ +#define UART_OMAP_SYSS 0x16 /* System status register */ +#define UART_OMAP_WER 0x17 /* Wake-up enable register */ + +#endif /* _8250_SERIAL_H */ + diff --git a/ports/mips/Doxyfile b/ports/mips/Doxyfile new file mode 100644 index 0000000..8e621b7 --- /dev/null +++ b/ports/mips/Doxyfile @@ -0,0 +1,1161 @@ +# Doxyfile 1.3.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = atomthreads + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = doxygen-mips + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of source +# files, where putting all generated files in the same directory would otherwise +# cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of +# the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. + +SHOW_DIRECTORIES = YES + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# that are symbolic links (a Unix filesystem feature) are excluded from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. + +EXCLUDE_PATTERNS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_PREDEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the +# parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# recommended to install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found on the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# If 0 is used for the depth value (the default), the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/ports/mips/Makefile b/ports/mips/Makefile new file mode 100644 index 0000000..04d340b --- /dev/null +++ b/ports/mips/Makefile @@ -0,0 +1,140 @@ +############ +# Settings # +############ + +# Build all test applications: +# make +# +# Program a test application using UISP (appname => test app e.g. sems1): +# make program app=appname + +# Location of build tools and atomthreads sources +KERNEL_DIR=../../kernel +TESTS_DIR=../../tests +CC=mips-linux-gnu-gcc +OBJCOPY=mips-linux-gnu-objcopy + +# Check if verbosity is ON for build process +VERBOSE_DEFAULT := 0 +CMD_PREFIX_DEFAULT := @ +ifdef VERBOSE + ifeq ("$(origin VERBOSE)", "command line") + VB := $(VERBOSE) + else + VB := $(VERBOSE_DEFAULT) + endif +else + VB := $(VERBOSE_DEFAULT) +endif +ifeq ($(VB), 1) + V := +else + V := $(CMD_PREFIX_DEFAULT) +endif + +# Enable stack-checking. WARNING: the full automated test suite currently +# requires a little over 1KB RAM with stack-checking enabled. If you are +# using a device with 1KB internal SRAM and no external SRAM then you +# must disable stack-checking to run all of the automated tests. +#STACK_CHECK=true + +# Directory for built objects +BUILD_DIR=build + +# Port/application object files +APP_OBJECTS = atomport.o tests-main.o 8250-serial.o printk.o string.o vsprintf.o io.o atomport-interrupts.o atomport-timer.o + +APP_ASM_OBJECTS = atomport-entry.o atomport-asm.o + +# Kernel object files +KERNEL_OBJECTS = atomkernel.o atomsem.o atommutex.o atomtimer.o atomqueue.o + +# Collection of built objects (excluding test applications) +ALL_OBJECTS = $(APP_ASM_OBJECTS) $(APP_OBJECTS) $(KERNEL_OBJECTS) +BUILT_OBJECTS = $(patsubst %,$(BUILD_DIR)/%,$(ALL_OBJECTS)) + +# Test object files (dealt with separately as only one per application build) +TEST_OBJECTS = $(notdir $(patsubst %.c,%.o,$(wildcard $(TESTS_DIR)/*.c))) + +# Target application filenames (.elf and .hex) for each test object +TEST_ELFS = $(patsubst %.o,%.elf,$(TEST_OBJECTS)) +TEST_HEXS = $(patsubst %.o,%.hex,$(TEST_OBJECTS)) + +# Search build/output directory for dependencies +vpath %.o ./$(BUILD_DIR) +vpath %.elf ./$(BUILD_DIR) +vpath %.hex ./$(BUILD_DIR) + +# GCC flags +CFLAGS= -g \ + -Wall \ + -Werror \ + -O \ + -fstrength-reduce \ + -fomit-frame-pointer \ + -finline-functions \ + -nostdinc \ + -fno-builtin \ + -fno-stack-protector + +# Enable stack-checking (disable if not required) +ifeq ($(STACK_CHECK),true) +CFLAGS += -DATOM_STACK_CHECKING +endif + +################# +# Build targets # +################# + +# All tests +all: $(BUILD_DIR) $(TEST_HEXS) Makefile + +# Make build/output directory +$(BUILD_DIR): + mkdir $(BUILD_DIR) + +# Test HEX files (one application build for each test) +$(TEST_HEXS): %.hex: %.elf + $(if $(V), @echo " (HEX) $(subst $(build_dir)/,,$@)") + $(V)$(OBJCOPY) -j .text -j .data -O ihex $(BUILD_DIR)/$< $(BUILD_DIR)/$@ + +# Test ELF files (one application build for each test) +$(TEST_ELFS): %.elf: %.o $(APP_ASM_OBJECTS) $(KERNEL_OBJECTS) $(APP_OBJECTS) + $(if $(V), @echo " (ELF) $(subst $(build_dir)/,,$@)") + $(V)$(CC) $(CFLAGS) -nostdlib -nodefaultlibs $(BUILD_DIR)/$(notdir $<) $(BUILT_OBJECTS) --output $(BUILD_DIR)/$@ -Wl -T linker.ld + +# Kernel objects builder +$(KERNEL_OBJECTS): %.o: $(KERNEL_DIR)/%.c + $(if $(V), @echo " (CC) $(subst $(build_dir)/,,$@)") + $(V)$(CC) -c $(CFLAGS) -I. -I$(KERNEL_DIR) $< -o $(BUILD_DIR)/$(notdir $@) + +# Test objects builder +$(TEST_OBJECTS): %.o: $(TESTS_DIR)/%.c + $(if $(V), @echo " (CC) $(subst $(build_dir)/,,$@)") + $(V)$(CC) -c $(CFLAGS) -I. -I$(KERNEL_DIR) $< -o $(BUILD_DIR)/$(notdir $@) + +# Application C objects builder +$(APP_OBJECTS): %.o: ./%.c + $(if $(V), @echo " (CC) $(subst $(build_dir)/,,$@)") + $(V)$(CC) -c $(CFLAGS) -I. -I$(KERNEL_DIR) -I$(TESTS_DIR) $< -o $(BUILD_DIR)/$(notdir $@) + +# Application asm objects builder +$(APP_ASM_OBJECTS): %.o: ./%.s + $(if $(V), @echo " (AS) $(subst $(build_dir)/,,$@)") + $(V)$(CC) -c $(CFLAGS) -D__ASSEMBLY__ -x assembler-with-cpp -I. -I$(KERNEL_DIR) $< -o $(BUILD_DIR)/$(notdir $@) + +# .lst file builder +%.lst: %.c + $(if $(V), @echo " (LST) $(subst $(build_dir)/,,$@)") + $(V)$(CC) $(CFLAGS) -I. -I$(KERNEL_DIR) -I$(TESTS_DIR) -Wa,-al $< > $@ + +# Clean +clean: + $(V)rm -f *.o *.elf *.map *.hex *.bin *.lst + rm -rf doxygen-kernel + rm -rf doxygen-mips + rm -rf build + +doxygen: + doxygen $(KERNEL_DIR)/Doxyfile + doxygen ./Doxyfile diff --git a/ports/mips/README b/ports/mips/README new file mode 100644 index 0000000..5f778c8 --- /dev/null +++ b/ports/mips/README @@ -0,0 +1,3 @@ + * Required Ubuntu packages: qemu, qemu-kvm-extras + * Compiler: CodeSourcery + * Run test: qemu-system-mips -M mips -m 128 -kernel build/kern1.elf -nographic diff --git a/ports/mips/atomport-asm-macros.h b/ports/mips/atomport-asm-macros.h new file mode 100644 index 0000000..39b9bb6 --- /dev/null +++ b/ports/mips/atomport-asm-macros.h @@ -0,0 +1,283 @@ +#ifndef __ATOMPORT_ASM_MACROS_H_ +#define __ATOMPORT_ASM_MACROS_H_ + +#include "regs.h" + +#ifdef __ASSEMBLY__ /* to be called only from assembly */ + +#define LEAF(fn) \ + .globl fn; \ + .ent fn; \ +fn: + +#define END(fn) \ + .size fn,.-fn; \ + .end fn + +#define tlbp_write_hazard \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; + +#define tlbp_read_hazard \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; + +#define tlbw_write_hazard \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; \ + nop; + +#define enable_global_interrupts ei $0 +#define disable_global_interrupts di $0 + +#define EXCEPTION_VECTOR(_name, _offset, _where)\ + . = _offset; \ + .set noreorder; \ +_name: \ + b _where; \ + nop; + +#define SAVE_REG(reg, treg) \ + sw reg, ((reg ## _IDX) * 4)(treg) + +#define LOAD_REG(reg, treg) \ + lw reg, ((reg ## _IDX) * 4)(treg) + +#define SAVE_INT_CONTEXT \ + addiu sp, sp, -((NUM_REGISTERS + 1)* 4); \ + mfc0 k1, CP0_EPC; \ + SAVE_REG(t0,sp); \ + SAVE_REG(t1,sp); \ + SAVE_REG(t2,sp); \ + SAVE_REG(t3,sp); \ + SAVE_REG(t4,sp); \ + SAVE_REG(t5,sp); \ + SAVE_REG(t6,sp); \ + SAVE_REG(t7,sp); \ + SAVE_REG(t8,sp); \ + SAVE_REG(t9,sp); \ + SAVE_REG(v0,sp); \ + SAVE_REG(v1,sp); \ + SAVE_REG(a0,sp); \ + SAVE_REG(a1,sp); \ + SAVE_REG(a2,sp); \ + SAVE_REG(a3,sp); \ + SAVE_REG(s0,sp); \ + SAVE_REG(s1,sp); \ + SAVE_REG(s2,sp); \ + SAVE_REG(s3,sp); \ + SAVE_REG(s4,sp); \ + SAVE_REG(s5,sp); \ + SAVE_REG(s6,sp); \ + SAVE_REG(s7,sp); \ + SAVE_REG(gp,sp); \ + SAVE_REG(s8,sp); \ + SAVE_REG(ra,sp); \ + sw k0, (sp_IDX * 4)(sp); \ + sw k1, (NUM_REGISTERS * 4)(sp); + +#define RESTORE_INT_CONTEXT \ + lw k1, (NUM_REGISTERS * 4)(sp); \ + mtc0 k1, CP0_EPC; \ + LOAD_REG(s0,sp); \ + LOAD_REG(s1,sp); \ + LOAD_REG(s2,sp); \ + LOAD_REG(s3,sp); \ + LOAD_REG(s4,sp); \ + LOAD_REG(s5,sp); \ + LOAD_REG(s6,sp); \ + LOAD_REG(s7,sp); \ + LOAD_REG(v0,sp); \ + LOAD_REG(v1,sp); \ + LOAD_REG(a0,sp); \ + LOAD_REG(a1,sp); \ + LOAD_REG(a2,sp); \ + LOAD_REG(a3,sp); \ + LOAD_REG(t0,sp); \ + LOAD_REG(t1,sp); \ + LOAD_REG(t2,sp); \ + LOAD_REG(t3,sp); \ + LOAD_REG(t4,sp); \ + LOAD_REG(t5,sp); \ + LOAD_REG(t6,sp); \ + LOAD_REG(t7,sp); \ + LOAD_REG(t8,sp); \ + LOAD_REG(t9,sp); \ + LOAD_REG(gp,sp); \ + LOAD_REG(ra,sp); \ + LOAD_REG(s8,sp); \ + lw sp, (sp_IDX * 4)(sp); + +#endif /* __ASSEMBLY__ */ + +#define num_to_string(s) to_string(s) +#define to_string(s) #s + +#define IASM_SAVE_REG(reg, here) \ + "sw " to_string(reg) " , " num_to_string(reg ## _IDX) \ + " * 4(" num_to_string(here)" )\n\t" + +#define IASM_LOAD_REG(reg, here) \ + "lw " to_string(reg) " , " num_to_string(reg ## _IDX) \ + " * 4(" num_to_string(here)" )\n\t" + + +/* + * Macros to be used with C code. + */ +#define __read_32bit_c0_register(source, sel) \ +({ int __res; \ + if (sel == 0) \ + __asm__ __volatile__( \ + "mfc0\t%0, " #source "\n\t" \ + : "=r" (__res)); \ + else \ + __asm__ __volatile__( \ + ".set\tmips32\n\t" \ + "mfc0\t%0, " #source ", " #sel "\n\t" \ + ".set\tmips0\n\t" \ + : "=r" (__res)); \ + __res; \ +}) + +#define __write_32bit_c0_register(register, sel, value) \ +do { \ + if (sel == 0) \ + __asm__ __volatile__( \ + "mtc0\t%z0, " #register "\n\t" \ + : : "Jr" ((unsigned int)(value))); \ + else \ + __asm__ __volatile__( \ + ".set\tmips32\n\t" \ + "mtc0\t%z0, " #register ", " #sel "\n\t" \ + ".set\tmips0" \ + : : "Jr" ((unsigned int)(value))); \ +} while (0) + +#define __read_ulong_c0_register(reg, sel) \ + (unsigned long) __read_32bit_c0_register(reg, sel) + +#define __write_ulong_c0_register(reg, sel, val) \ +do { \ + __write_32bit_c0_register(reg, sel, val); \ +} while (0) + +#define read_c0_index() __read_32bit_c0_register($0, 0) +#define write_c0_index(val) __write_32bit_c0_register($0, 0, val) + +#define read_c0_entrylo0() __read_ulong_c0_register($2, 0) +#define write_c0_entrylo0(val) __write_ulong_c0_register($2, 0, val) + +#define read_c0_entrylo1() __read_ulong_c0_register($3, 0) +#define write_c0_entrylo1(val) __write_ulong_c0_register($3, 0, val) + +#define read_c0_conf() __read_32bit_c0_register($3, 0) +#define write_c0_conf(val) __write_32bit_c0_register($3, 0, val) + +#define read_c0_context() __read_ulong_c0_register($4, 0) +#define write_c0_context(val) __write_ulong_c0_register($4, 0, val) + +#define read_c0_userlocal() __read_ulong_c0_register($4, 2) +#define write_c0_userlocal(val) __write_ulong_c0_register($4, 2, val) + +#define read_c0_pagemask() __read_32bit_c0_register($5, 0) +#define write_c0_pagemask(val) __write_32bit_c0_register($5, 0, val) + +#define read_c0_wired() __read_32bit_c0_register($6, 0) +#define write_c0_wired(val) __write_32bit_c0_register($6, 0, val) + +#define read_c0_info() __read_32bit_c0_register($7, 0) + +#define read_c0_badvaddr() __read_ulong_c0_register($8, 0) +#define write_c0_badvaddr(val) __write_ulong_c0_register($8, 0, val) + +#define read_c0_count() __read_32bit_c0_register($9, 0) +#define write_c0_count(val) __write_32bit_c0_register($9, 0, val) + +#define read_c0_entryhi() __read_ulong_c0_register($10, 0) +#define write_c0_entryhi(val) __write_ulong_c0_register($10, 0, val) + +#define read_c0_compare() __read_32bit_c0_register($11, 0) +#define write_c0_compare(val) __write_32bit_c0_register($11, 0, val) + +#define read_c0_status() __read_32bit_c0_register($12, 0) +#define write_c0_status(val) __write_32bit_c0_register($12, 0, val) + +#define read_c0_cause() __read_32bit_c0_register($13, 0) +#define write_c0_cause(val) __write_32bit_c0_register($13, 0, val) + +#define read_c0_epc() __read_ulong_c0_register($14, 0) +#define write_c0_epc(val) __write_ulong_c0_register($14, 0, val) + +#define read_c0_prid() __read_32bit_c0_register($15, 0) + +#define read_c0_config() __read_32bit_c0_register($16, 0) +#define read_c0_config1() __read_32bit_c0_register($16, 1) +#define read_c0_config2() __read_32bit_c0_register($16, 2) +#define write_c0_config(val) __write_32bit_c0_register($16, 0, val) +#define write_c0_config1(val) __write_32bit_c0_register($16, 1, val) +#define write_c0_config2(val) __write_32bit_c0_register($16, 2, val) + +#define read_c0_xcontext() __read_ulong_c0_register($20, 0) +#define write_c0_xcontext(val) __write_ulong_c0_register($20, 0, val) + +#define read_c0_intcontrol() __read_32bit_c0_ctrl_register($20) +#define write_c0_intcontrol(val) __write_32bit_c0_ctrl_register($20, val) + +#define read_c0_framemask() __read_32bit_c0_register($21, 0) +#define write_c0_framemask(val) __write_32bit_c0_register($21, 0, val) + +/* + * MIPS32 / MIPS64 performance counters + */ +#define read_c0_cacheerr() __read_32bit_c0_register($27, 0) + +#define read_c0_taglo() __read_32bit_c0_register($28, 0) +#define write_c0_taglo(val) __write_32bit_c0_register($28, 0, val) + +#define read_c0_dtaglo() __read_32bit_c0_register($28, 2) +#define write_c0_dtaglo(val) __write_32bit_c0_register($28, 2, val) + +#define read_c0_taghi() __read_32bit_c0_register($29, 0) +#define write_c0_taghi(val) __write_32bit_c0_register($29, 0, val) + +#define read_c0_errorepc() __read_ulong_c0_register($30, 0) +#define write_c0_errorepc(val) __write_ulong_c0_register($30, 0, val) + +/* MIPSR2 */ +#define read_c0_hwrena() __read_32bit_c0_register($7, 0) +#define write_c0_hwrena(val) __write_32bit_c0_register($7, 0, val) + +#define read_c0_intctl() __read_32bit_c0_register($12, 1) +#define write_c0_intctl(val) __write_32bit_c0_register($12, 1, val) + +#define read_c0_srsctl() __read_32bit_c0_register($12, 2) +#define write_c0_srsctl(val) __write_32bit_c0_register($12, 2, val) + +#define read_c0_srsmap() __read_32bit_c0_register($12, 3) +#define write_c0_srsmap(val) __write_32bit_c0_register($12, 3, val) + +#define read_c0_ebase() __read_32bit_c0_register($15, 1) +#define write_c0_ebase(val) __write_32bit_c0_register($15, 1, val) + +#endif /* __ATOMPORT_ASM_MACROS_H_ */ diff --git a/ports/mips/atomport-asm.s b/ports/mips/atomport-asm.s new file mode 100644 index 0000000..2b64746 --- /dev/null +++ b/ports/mips/atomport-asm.s @@ -0,0 +1,186 @@ +/* + * Copyright (c) 2010, Atomthreads Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#include + +.section .text + +.extern atomCurrentContext +.extern at_preempt_count + +/** + * Function that performs the contextSwitch. Whether its a voluntary release + * of CPU by thread or a pre-emption, under both conditions this function is + * called. The signature is as follows: + * + * archContextSwitch(ATOM_TCB *old_tcb, ATOM_TCB *new_tcb) + */ +.globl archContextSwitch +archContextSwitch: + /* + * Check if we are being called in interrupt + * context. If yes, we need to restore complete + * context and return directly from here. + */ + move k0, ra + bal atomCurrentContext + nop + beq v0, zero, __in_int_context + nop + + move ra, k0 + move v0, a0 /* return old tcb when we return from here */ + lw k0, 0(a0) /* assume that sp_save_ptr is always at base of ATOM_TCB */ + sw s0, (s0_IDX * 4)(k0) + sw s1, (s1_IDX * 4)(k0) + sw s2, (s2_IDX * 4)(k0) + sw s3, (s3_IDX * 4)(k0) + sw s4, (s4_IDX * 4)(k0) + sw s5, (s5_IDX * 4)(k0) + sw s6, (s6_IDX * 4)(k0) + sw s7, (s7_IDX * 4)(k0) + sw s8, (s8_IDX * 4)(k0) + sw sp, (sp_IDX * 4)(k0) + sw gp, (gp_IDX * 4)(k0) + sw ra, (ra_IDX * 4)(k0) + /* + * We are saving registers in non-interrupt context because + * a thread probably is trying to yield CPU. Storing zero + * in EPC offset differentiates this. When restoring the + * context, if EPC offset has zero we will restore only + * the partial context. Rest will be done by GCC while + * unwinding the call. + */ + sw zero, (cp0_epc_IDX * 4)(k0) + + lw k1, 0(a1) + lw k0, (cp0_epc_IDX * 4)(k1) + bnez k0, __unwind_int_context + nop + + lw s0, (s0_IDX * 4)(k1) + lw s1, (s1_IDX * 4)(k1) + lw s2, (s2_IDX * 4)(k1) + lw s3, (s3_IDX * 4)(k1) + lw s4, (s4_IDX * 4)(k1) + lw s5, (s5_IDX * 4)(k1) + lw s6, (s6_IDX * 4)(k1) + lw s7, (s7_IDX * 4)(k1) + lw s8, (s8_IDX * 4)(k1) + lw sp, (sp_IDX * 4)(k1) + lw gp, (gp_IDX * 4)(k1) + lw ra, (ra_IDX * 4)(k1) + + jr ra + nop + +__in_int_context: + move ra, k0 + /* + * In interrupt context, the interrupt handler + * saves the context for us. Its very well there + * and we don't need to do it again. + * + * We will figure out of the task that we are + * switching in was saved in interrupt context + * or otherwise. + */ + lw k0, (cp0_epc_IDX * 4)(k1) + bnez k0, __unwind_int_context + nop + + /* + * Unwinding a task switched in non-interrupt context. + * So, restore only the partials. But since we are in + * interrupt mode, we will put ra in epc and do a eret + * so that we get out of interrupt mode and switch to + * the new task. + */ +__unwind_non_int_context: + lw s0, (s0_IDX * 4)(k1) + lw s1, (s1_IDX * 4)(k1) + lw s2, (s2_IDX * 4)(k1) + lw s3, (s3_IDX * 4)(k1) + lw s4, (s4_IDX * 4)(k1) + lw s5, (s5_IDX * 4)(k1) + lw s6, (s6_IDX * 4)(k1) + lw s7, (s7_IDX * 4)(k1) + lw s8, (s8_IDX * 4)(k1) + lw sp, (sp_IDX * 4)(k1) + lw gp, (gp_IDX * 4)(k1) + lw ra, (ra_IDX * 4)(k1) + mtc0 ra, CP0_EPC + nop + nop + nop + j __ret_from_switch + nop + +__unwind_int_context: + move sp, k1 + RESTORE_INT_CONTEXT + +__ret_from_switch: + la k0, at_preempt_count + lw k1, (k0) + addi k1, k1, -1 + sw k1, (k0) + bnez k1, __return_from_int + nop + enable_global_interrupts + ehb +__return_from_int: + eret + +/** + * archFirstThreadRestore(ATOM_TCB *new_tcb) + * + * This function is responsible for restoring and starting the first + * thread the OS runs. It expects to find the thread context exactly + * as it would be if a context save had previously taken place on it. + * The only real difference between this and the archContextSwitch() + * routine is that there is no previous thread for which context must + * be saved. + * + * The final action this function must do is to restore interrupts. + */ +.globl archFirstThreadRestore +archFirstThreadRestore: + move k0, a0 /* save the copy of tcb pointer in k0 */ + lw k1, 0(k0) /* Assume that sp_save_ptr is always at base of ATOM_TCB */ + lw a0, (a0_IDX * 4)(k1) + lw sp, (sp_IDX * 4)(k1) + lw s8, (s8_IDX * 4)(k1) + lw k0, (ra_IDX * 4)(k1) + mtc0 k0, CP0_EPC + nop + nop + nop + enable_global_interrupts + eret diff --git a/ports/mips/atomport-entry.s b/ports/mips/atomport-entry.s new file mode 100644 index 0000000..35b5735 --- /dev/null +++ b/ports/mips/atomport-entry.s @@ -0,0 +1,161 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#include "atomport-asm-macros.h" + +.extern _stack_start +.section .start.text,"ax",@progbits + +EXCEPTION_VECTOR(_tlbmiss, 0x00, _handle_tlbmiss) +EXCEPTION_VECTOR(_cache_error, 0x100, _handle_cache_error) +EXCEPTION_VECTOR(_general_exception, 0x180, _handle_general_exception) +/* FIXME: We don't need this when in EIC mode. */ +EXCEPTION_VECTOR(_interrupts, 0x200, _handle_interrupt) + +LEAF(_start) + mtc0 zero, CP0_CONTEXT + nop + nop + nop + + /* globally disable interrupts until we are prepared. */ + disable_global_interrupts + + /* clear CPU timer counters. We don't want surprises. */ + mtc0 zero, CP0_COMPARE + mtc0 zero, CP0_COUNT + + li a0, 0xC0000000 /* FIXME: Remove these two hard codings */ + li a1, 0x14000000 + bal create_tlb_entry + move zero, a2 + + la sp, _stack_start /* setup the stack (bss segment) */ + la t0, main + j t0 /* Call the C- code now */ + nop + +1: b 1b /* we should not come here whatsoever */ +END(_start) + +LEAF(_handle_tlbmiss) +#if 0 + disable_global_interrupts + move k0, sp + SAVE_INT_CONTEXT(_int_stack) + move a0, sp + bal vmm_cpu_handle_pagefault + nop + enable_global_interrupts + eret +#else + b _handle_tlbmiss + nop +#endif +END(_handle_tlbmiss) + +.extern handle_mips_systick +.extern _int_stack +LEAF(_handle_interrupt) + disable_global_interrupts + mfc0 k0, CP0_CAUSE + lui k1, 0x4000 + and k0, k1, k0 + beq k0, zero, 1f + nop + + move k0, ra + move k1, v0 + bal atomCurrentContext + nop + beq v0, zero, 2f /* v0 should be current context */ + nop + + move ra, k0 + lw k0, 0(v0) + move v0, k1 + move k1, k0 + /* + * Note that we aren't loading any new SP. Context + * will be save on the interrupted threads' stack. + */ + move k0, sp + move sp, k1 + SAVE_INT_CONTEXT + bal handle_mips_systick + nop + RESTORE_INT_CONTEXT +1: + enable_global_interrupts + eret + +2: b 2b +END(_handle_interrupt) + +LEAF(_handle_cache_error) + b _handle_cache_error + nop +END(_handle_cache_error) + +LEAF(_handle_general_exception) + b _handle_general_exception + nop +END(_handle_general_exception) + +/** + * a0 -> Contains virtual address. + * a1 -> Contains physical address. + * a2 -> TLB index: If -1 select automatically. + */ +.globl create_tlb_entry +LEAF(create_tlb_entry) + mtc0 a2, CP0_INDEX /* load the tlb index to be programmed. */ + srl a0, a0, 12 /* get the VPN */ + sll a0, a0, 12 + nop + mtc0 a0, CP0_ENTRYHI /* load VPN in entry hi */ + addi t0, a1, 0x1000 /* next PFN for entry lo1 in T0 */ + srl a1, a1, 12 /* get the PFN */ + sll a1, a1, 6 /* get the PFN */ + srl t0, t0, 12 + sll t0, t0, 6 + ori a1, a1, 0x7 /* mark the page writable, global and valid */ + mtc0 a1, CP0_ENTRYLO0 + ori t0, t0, 0x7 /* mark the next physical page writable, global and valid */ + nop + nop + mtc0 t0, CP0_ENTRYLO1 + nop + nop + nop + tlbwi + ehb + j ra + nop +END(create_tlb_entry) diff --git a/ports/mips/atomport-interrupts.c b/ports/mips/atomport-interrupts.c new file mode 100644 index 0000000..e0065da --- /dev/null +++ b/ports/mips/atomport-interrupts.c @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#include +#include +#include + +void mips_setup_interrupts() +{ + uint32_t ebase = read_c0_ebase(); + ebase &= ~0x3FFF000UL; + write_c0_ebase(ebase); + + uint32_t sr = read_c0_status(); + sr &= ~(0x01UL << 22); + sr &= ~(0x3UL << 1); + write_c0_status(sr); + + uint32_t cause = read_c0_status(); + cause |= 0x01UL << 23; + write_c0_cause(cause); +} + +void mips_enable_global_interrupts(void) +{ + __asm__ __volatile__ ("ei $0\t\n"); +} + +void mips_disable_global_interrupts(void) +{ + __asm__ __volatile__("di $0\t\n"); +} diff --git a/ports/mips/atomport-interrupts.h b/ports/mips/atomport-interrupts.h new file mode 100644 index 0000000..41200de --- /dev/null +++ b/ports/mips/atomport-interrupts.h @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#ifndef __ATOMPORT_INTERRUPTS_H +#define __ATOMPORT_INTERRUPTS_H + +void mips_setup_interrupts(); +void mips_enable_global_interrupts(void); +void mips_disable_global_interrupts(void); +void handle_mips_systick(void); + +#endif /* __ATOMPORT_INTERRUPTS_H */ diff --git a/ports/mips/atomport-private.h b/ports/mips/atomport-private.h new file mode 100644 index 0000000..499a5a9 --- /dev/null +++ b/ports/mips/atomport-private.h @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2010, Atomthreads Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#ifndef __ATOMPORT_PRIVATE_H_ +#define __ATOMPORT_PRIVATE_H_ + +/* Function prototypes */ +void mips_cpu_timer_enable(void); + +#endif /* __ATOMPORT_PRIVATE_H_ */ diff --git a/ports/mips/atomport-tests.h b/ports/mips/atomport-tests.h new file mode 100644 index 0000000..4b44513 --- /dev/null +++ b/ports/mips/atomport-tests.h @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#ifndef __ATOM_PORT_TESTS_H +#define __ATOM_PORT_TESTS_H + +/* Include Atomthreads kernel API */ +#include "atom.h" + +/* Prerequisite include for ATOMLOG() macro (via printf) */ +#include "printk.h" + +/* Logger macro for viewing test results */ +/* FIXME: Add uart out routine once uart is supported */ +#define ATOMLOG printk +#define _STR + +/* Default thread stack size (in bytes) */ +#define TEST_THREAD_STACK_SIZE 8192 + +/* Uncomment to enable logging of stack usage to UART */ +/* #define TESTS_LOG_STACK_USAGE */ + +#endif /* __ATOM_PORT_TESTS_H */ + diff --git a/ports/mips/atomport-timer.c b/ports/mips/atomport-timer.c new file mode 100644 index 0000000..3997a29 --- /dev/null +++ b/ports/mips/atomport-timer.c @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#include +#include +#include +#include + +/** CPU frequency in MHz */ +#define CPU_FREQ_MHZ 100 + +/** Number of counter counter should increase to get required ticks */ +#define COUNTER_TICK_COUNT ((1000000 * SYSTEM_TICKS_PER_SEC) / CPU_FREQ_MHZ) + +unsigned long long jiffies; + +void mips_cpu_timer_enable(void) +{ + uint32_t sr = read_c0_status(); + sr |= ((0x1UL << 7) << 8); + write_c0_status(sr); + + uint32_t cause = read_c0_cause(); + cause &= ~(0x1UL << 27); + write_c0_cause(cause); + write_c0_compare(read_c0_count() + COUNTER_TICK_COUNT); +} + +void handle_mips_systick(void) +{ + /* Call the interrupt entry routine */ + atomIntEnter(); + + /* Call the OS system tick handler */ + atomTimerTick(); + + /* Call the interrupt exit routine */ + atomIntExit(TRUE); + + write_c0_compare(read_c0_count() + COUNTER_TICK_COUNT); +} diff --git a/ports/mips/atomport.c b/ports/mips/atomport.c new file mode 100644 index 0000000..0af7f71 --- /dev/null +++ b/ports/mips/atomport.c @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan for Atomthreads Project. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#include +#include +#include +#include "regs.h" +#include + + +/* Used for managing nesting of atomport.h critical sections */ +uint32_t at_preempt_count = 0; + +/** + * This function initialises each thread's stack during creation, before the + * thread is first run. New threads are scheduled in using the same + * context-switch function used for threads which were previously scheduled + * out, therefore this function should set up a stack context which looks + * much like a thread which has been scheduled out and had its context saved. + * We fill part of the stack with those registers which are involved in the + * context switch, including appropriate stack or register contents to cause + * the thread to branch to its entry point function when it is scheduled in. + * + * Interrupts should also be enabled whenever a thread is restored, hence + * ports may wish to explicitly include the interrupt-enable register here + * which will be restored when the thread is scheduled in. Other methods + * can be used to enable interrupts, however, without explicitly storing + * it in the thread's context. + */ +void archThreadContextInit (ATOM_TCB *tcb_ptr, void *stack_top, + void (*entry_point)(UINT32), + UINT32 entry_param) +{ + +#define STORE_VAL(base, reg, val) \ + *((uint32_t *)(base + ((reg ## _IDX) * WORD_SIZE))) = (uint32_t)val + + uint32_t stack_start = (uint32_t)(stack_top - (WORD_SIZE * (NUM_REGISTERS + 1))); + + tcb_ptr->sp_save_ptr = (void *)stack_start; + + STORE_VAL(stack_start, sp, stack_start); + STORE_VAL(stack_start, s8, stack_start); + STORE_VAL(stack_start, s1, 0); + STORE_VAL(stack_start, s2, 0); + STORE_VAL(stack_start, s3, 0); + STORE_VAL(stack_start, s4, 0); + STORE_VAL(stack_start, s5, 0); + STORE_VAL(stack_start, s6, 0); + STORE_VAL(stack_start, s7, 0); + STORE_VAL(stack_start, cp0_epc, entry_point); + STORE_VAL(stack_start, ra, entry_point); + STORE_VAL(stack_start, a0, entry_param); +} + diff --git a/ports/mips/atomport.h b/ports/mips/atomport.h new file mode 100644 index 0000000..b7a6832 --- /dev/null +++ b/ports/mips/atomport.h @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#ifndef __ATOM_PORT_H +#define __ATOM_PORT_H + + +/* Required number of system ticks per second (normally 100 for 10ms tick) */ +#define SYSTEM_TICKS_PER_SEC 100 + +/** + * Definition of NULL. stddef.h not available on this platform. + */ +#define NULL ((void *)(0)) + +/* Size of each stack entry / stack alignment size (32 bits on MIPS) */ +#define STACK_ALIGN_SIZE sizeof(uint32_t) + +/** + * Architecture-specific types. + * Provide stdint.h style types. + */ +#define uint8_t unsigned char +#define uint16_t unsigned short +#define uint32_t unsigned long +#define uint64_t unsigned long long +#define int8_t char +#define int16_t short +#define int32_t long +#define int64_t long long +#define size_t unsigned long +#define POINTER void * +#define UINT32 uint32_t + + +/** + * Critical region protection: this should disable interrupts + * to protect OS data structures during modification. It must + * allow nested calls, which means that interrupts should only + * be re-enabled when the outer CRITICAL_END() is reached. + */ +extern uint32_t at_preempt_count; +#define CRITICAL_STORE uint32_t status_reg +#define CRITICAL_START() \ + do { \ + __asm__ __volatile__("di %0\t\n" \ + "ehb\t\n" \ + :"=r"(status_reg)); \ + at_preempt_count++; \ + }while(0); + +#define CRITICAL_END() \ + do { \ + at_preempt_count--; \ + \ + if (at_preempt_count == 0) { \ + if (atomCurrentContext()) { \ + __asm__ __volatile__("ei %0\t\n" \ + "ehb\t\n" \ + ::"r"(status_reg));\ + } \ + } \ + \ + }while(0); + +/* Uncomment to enable stack-checking */ +/* #define ATOM_STACK_CHECKING */ + + +#endif /* __ATOM_PORT_H */ diff --git a/ports/mips/io.c b/ports/mips/io.c new file mode 100644 index 0000000..90b714c --- /dev/null +++ b/ports/mips/io.c @@ -0,0 +1,44 @@ +/* + * Copyright (c) Himanshu Chauhan 2009-11. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#include + +uint8_t ioreadb (void *addr) +{ + uint8_t rv; + rv = *((volatile uint8_t *)addr); + return rv; +} + +void iowriteb (void *addr, uint8_t data) +{ + *(volatile uint8_t *)addr = data; +} + diff --git a/ports/mips/linker.ld b/ports/mips/linker.ld new file mode 100755 index 0000000..98d6df6 --- /dev/null +++ b/ports/mips/linker.ld @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +OUTPUT_FORMAT("elf32-tradbigmips") +OUTPUT_ARCH("mips") +ENTRY(_start) + +SECTIONS +{ + . = 0x80000000; + .text : + { + *(.start.text) + *(.text) + . = ALIGN(4); + _etext = .; + } + + .data : + { + *(.data) + . = ALIGN(4); + _edata = .; + } + + .bss : + { + *(.bss) + . = ALIGN(4); + _ebss = .; + } + + .rodata : + { + *(.rodata .rodata.*) + . = ALIGN(4); + _erodata = .; + } + + PROVIDE(_stack_end = .); + . = . + 8192; + . = ALIGN(4); + PROVIDE(_stack_start = .); + PROVIDE(_int_stack_end = .); + . = . + 8192; + . = ALIGN(4); + PROVIDE(_int_stack = .); +} diff --git a/ports/mips/printk.c b/ports/mips/printk.c new file mode 100644 index 0000000..cf736ce --- /dev/null +++ b/ports/mips/printk.c @@ -0,0 +1,59 @@ +/* + * Copyright (c) Himanshu Chauhan 2009-11. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#include +#include "system.h" +#include "atomport.h" +#include "printk.h" + +static int8_t buf[2048]; + +/* Uses the above routine to output a string... */ +void puts(const uint8_t *text) +{ + int32_t i; + + for (i = 0; i < strlen((const int8_t *)text); i++) { + putch(text[i]); + } +} + +void printk(const char *format, ...) +{ + va_list args; + int i; + + va_start(args, format); + i = vsprintf(buf, (const int8_t *)format, args); + va_end(args); + + puts((const uint8_t *)buf); +} + diff --git a/ports/mips/printk.h b/ports/mips/printk.h new file mode 100644 index 0000000..bd1b192 --- /dev/null +++ b/ports/mips/printk.h @@ -0,0 +1,42 @@ +/* + * This file is part of Freax kernel. + * + * Copyright (c) Himanshu Chauhan 2009-10. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#ifndef _PRINTK_H +#define _PRINTK_H + +#include "atomport.h" + +extern void putch (uint8_t ch); +extern void puts (const uint8_t *text); +extern void printk (const char*format, ...); + +#endif diff --git a/ports/mips/regs.h b/ports/mips/regs.h new file mode 100644 index 0000000..ecf77d5 --- /dev/null +++ b/ports/mips/regs.h @@ -0,0 +1,144 @@ +/* + * Copyright (c) 2010, Atomthreads Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#ifndef __ATOMPORT_REGS_H_ +#define __ATOMPORT_REGS_H_ + + +#define zero $0 +#define at $1 +#define v0 $2 +#define v1 $3 +#define a0 $4 +#define a1 $5 +#define a2 $6 +#define a3 $7 +#define t0 $8 +#define t1 $9 +#define t2 $10 +#define t3 $11 +#define t4 $12 +#define t5 $13 +#define t6 $14 +#define t7 $15 +#define t8 $24 +#define t9 $25 +#define s0 $16 +#define s1 $17 +#define s2 $18 +#define s3 $19 +#define s4 $20 +#define s5 $21 +#define s6 $22 +#define s7 $23 +#define k0 $26 +#define k1 $27 +#define gp $28 +#define sp $29 +#define s8 $30 +#define fp $30 +#define ra $31 + +#define NUM_REGISTERS 32 +#define WORD_SIZE 4 + +#define v0_IDX 0 +#define v1_IDX 1 +#define a0_IDX 2 +#define a1_IDX 3 +#define a2_IDX 4 +#define a3_IDX 5 +#define t0_IDX 6 +#define t1_IDX 7 +#define t2_IDX 8 +#define t3_IDX 9 +#define t4_IDX 10 +#define t5_IDX 11 +#define t6_IDX 12 +#define t7_IDX 13 +#define s0_IDX 14 +#define s1_IDX 15 +#define s2_IDX 16 +#define s3_IDX 17 +#define s4_IDX 18 +#define s5_IDX 19 +#define s6_IDX 20 +#define s7_IDX 21 +#define t8_IDX 22 +#define t9_IDX 23 +#define sp_IDX 24 +#define gp_IDX 25 +#define s8_IDX 26 +#define ra_IDX 27 +#define k0_IDX 28 +#define k1_IDX 29 +#define at_IDX 30 +#define zero_IDX 31 +#define cp0_epc_IDX 32 + +#define CP0_INDEX $0 +#define CP0_RANDOM $1 +#define CP0_ENTRYLO0 $2 +#define CP0_ENTRYLO1 $3 +#define CP0_CONTEXT $4 +#define CP0_PAGEMASK $5 +#define CP0_WIRED $6 +#define CP0_HWRENA $7 +#define CP0_BADVADDR $8 +#define CP0_COUNT $9 +#define CP0_ENTRYHI $10 +#define CP0_COMPARE $11 +#define CP0_STATUS $12 +#define CP0_INTCTL $12,1 +#define CP0_SRSCTL $12,2 +#define CP0_SRSMAP $12,3 +#define CP0_CAUSE $13 +#define CP0_EPC $14 +#define CP0_PRID $15 +#define CP0_EBASE $15,1 +#define CP0_CONFIG $16 +#define CP0_CONFIG1 $16,1 +#define CP0_CONFIG2 $16,2 +#define CP0_CONFIG3 $16,3 +#define CP0_LLADDR $17 +#define CP0_WATCHLO $18 +#define CP0_WATCHHI $19 +#define CP0_DEBUG $23 +#define CP0_DEPC $24 +#define CP0_PERFCTL $25,0 +#define CP0_PERFCNT $25,1 +#define CP0_ECC $26 +#define CP0_CACHEERR $27 +#define CP0_TAGLO $28 +#define CP0_DATALO $28,1 +#define CP0_TAGHI $29 +#define CP0_DATAHI $29,1 +#define CP0_ERRORPC $30 + +#endif /* __ATOMPORT_REGS_H_ */ diff --git a/ports/mips/stdarg.h b/ports/mips/stdarg.h new file mode 100755 index 0000000..fd79ec0 --- /dev/null +++ b/ports/mips/stdarg.h @@ -0,0 +1,28 @@ +#ifndef _STDARG_H +#define _STDARG_H + +typedef char *va_list; + +/* Amount of space required in an argument list for an arg of type TYPE. + TYPE may alternatively be an expression whose type is used. */ + +#define __va_rounded_size(TYPE) \ + (((sizeof (TYPE) + sizeof (int) - 1) / sizeof (int)) * sizeof (int)) + +#ifndef __sparc__ +#define va_start(AP, LASTARG) \ + (AP = ((char *) &(LASTARG) + __va_rounded_size (LASTARG))) +#else +#define va_start(AP, LASTARG) \ + (__builtin_saveregs (), \ + AP = ((char *) &(LASTARG) + __va_rounded_size (LASTARG))) +#endif + +void va_end (va_list); /* Defined in gnulib */ +#define va_end(AP) + +#define va_arg(AP, TYPE) \ + (AP += __va_rounded_size (TYPE), \ + *((TYPE *) (AP - __va_rounded_size (TYPE)))) + +#endif /* _STDARG_H */ diff --git a/ports/mips/string.c b/ports/mips/string.c new file mode 100644 index 0000000..b99b529 --- /dev/null +++ b/ports/mips/string.c @@ -0,0 +1,61 @@ +/* + * Copyright (c) Himanshu Chauhan 2009-11. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#include +#include + +void *memcpy(void *dest, const void *src, size_t count) +{ + const int8_t *sp = (const int8_t *)src; + int8_t *dp = (int8_t *)dest; + for(; count != 0; count--) *dp++ = *sp++; + return dest; +} + +void *memset(void *dest, int8_t val, size_t count) +{ + int8_t *temp = (int8_t *)dest; + for( ; count != 0; count--) *temp++ = val; + return dest; +} + +uint16_t *memsetw(uint16_t *dest, uint16_t val, size_t count) +{ + uint16_t *temp = (uint16_t *)dest; + for( ; count != 0; count--) *temp++ = val; + return dest; +} + +size_t strlen(const int8_t *str) +{ + size_t retval; + for(retval = 0; *str != '\0'; str++) retval++; + return retval; +} diff --git a/ports/mips/string.h b/ports/mips/string.h new file mode 100644 index 0000000..bbccc25 --- /dev/null +++ b/ports/mips/string.h @@ -0,0 +1,42 @@ +/* + * Copyright (c) Himanshu Chauhan 2009-11. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#ifndef __STRING_H +#define __STRING_H + +#include + +void *memcpy(void *dest, const void *src, size_t count); +void *memset(void *dest, int8_t val, size_t count); +uint16_t *memsetw(uint16_t *dest, uint16_t val, size_t count); +size_t strlen(const int8_t *str); + +#endif /* __STRING_H */ + diff --git a/ports/mips/system.h b/ports/mips/system.h new file mode 100644 index 0000000..b8c25ad --- /dev/null +++ b/ports/mips/system.h @@ -0,0 +1,52 @@ +/* + * Copyright (c) Himanshu Chauhan 2009-11. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * 2. 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. + * + * 3. Neither the name of Himanshu Chauhan 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. + */ + +#ifndef _SYSTEM_H +#define _SYSTEM_H + +#include +#include + +extern const uint8_t *kernel_name; +extern const uint8_t *kernel_version; +extern const uint8_t *kernel_bdate; +extern const uint8_t *kernel_btime; + +extern void *memcpy (void *dest, const void *src, size_t count); +extern void *memset (void *dest, int8_t val, size_t count); +extern uint16_t *memsetw (uint16_t *dest, uint16_t val, size_t count); +extern size_t strlen (const int8_t *str); +extern int vsprintf (int8_t *buf, const int8_t *fmt, va_list args); +extern void init_console (void); +extern int32_t arch_init (void); +extern uint8_t ioreadb (void *addr); +extern void iowriteb (void *addr, uint8_t data); + +#endif /* _SYSTEM_H */ diff --git a/ports/mips/tests-main.c b/ports/mips/tests-main.c new file mode 100644 index 0000000..6e3e37b --- /dev/null +++ b/ports/mips/tests-main.c @@ -0,0 +1,260 @@ +/* + * Copyright (c) 2011, Himanshu Chauhan. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * 3. No personal names or organizations' names associated with the + * Atomthreads project may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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. + */ + +#include "atom.h" +#include "atomport-private.h" +#include "atomport.h" +#include "atomtests.h" +#include "atomtimer.h" +#include "system.h" +#include "atomport-interrupts.h" + + +/* Constants */ + +/* + * Idle thread stack size + * + * This needs to be large enough to handle any interrupt handlers + * and callbacks called by interrupt handlers (e.g. user-created + * timer callbacks) as well as the saving of all context when + * switching away from this thread. + * + * In this case, the idle stack is allocated on the BSS via the + * idle_thread_stack[] byte array. + */ +#define IDLE_STACK_SIZE_BYTES 8192 + + +/* + * Main thread stack size + * + * Note that this is not a required OS kernel thread - you will replace + * this with your own application thread. + * + * In this case the Main thread is responsible for calling out to the + * test routines. Once a test routine has finished, the test status is + * printed out on the UART and the thread remains running in a loop + * flashing a LED. + * + * The Main thread stack generally needs to be larger than the idle + * thread stack, as not only does it need to store interrupt handler + * stack saves and context switch saves, but the application main thread + * will generally be carrying out more nested function calls and require + * stack for application code local variables etc. + * + * With all OS tests implemented to date on the AVR, the Main thread + * stack has not exceeded 198 bytes. To allow all tests to run we set + * a minimum main thread stack size of 204 bytes. This may increase in + * future as the codebase changes but for the time being is enough to + * cope with all of the automated tests. + */ +#define MAIN_STACK_SIZE_BYTES 8192 + + +/* + * Startup code stack + * + * Some stack space is required at initial startup for running the main() + * routine. This stack space is only temporarily required at first bootup + * and is no longer required as soon as the OS is started. By default + * GCC sets this to the top of RAM (RAMEND) and it grows down from there. + * Because we only need this temporarily, though, it would be wasteful to + * set aside a region at the top of RAM which is not used during runtime. + * + * What we do here is to reuse part of the idle thread's stack during + * initial startup. As soon as we enter the main() routine we move the + * stack pointer to half-way down the idle thread's stack. This is used + * temporarily while calls are made to atomOSInit(), atomThreadCreate() + * and atomOSStart(). Once the OS is started this stack area is no + * longer required, and can be used for its original purpose (for the + * idle thread's stack). + * + * This does mean, however, that we cannot monitor the stack usage of the + * idle thread. Stack usage is monitored by prefilling the stack with a + * known value, and we are obliterating some of that prefilled area by + * using it as our startup stack, so we cannot use the stack-checking API + * to get a true picture of idle thread stack usage. If you wish to + * monitor idle thread stack usage for your applications then you are + * free to use a different region for the startup stack (e.g. set aside + * an area permanently, or place it somewhere you know you can reuse + * later in the application). For the time being, this method gives us a + * simple way of reducing the memory consumption without having to add + * any special AVR-specific considerations to the automated test + * applications. + * + * This optimisation was required to allow some of the larger automated + * test modules to run on devices with 1KB of RAM. You should avoid doing + * this if you can afford to set aside 64 bytes or so, or if you are + * writing your own applications in which you have further control over + * where data is located. + */ + + +/* Local data */ + +/* Application threads' TCBs */ +static ATOM_TCB main_tcb; + +/* Main thread's stack area */ +static uint8_t main_thread_stack[MAIN_STACK_SIZE_BYTES]; + +/* Idle thread's stack area */ +static uint8_t idle_thread_stack[IDLE_STACK_SIZE_BYTES]; + +/* Forward declarations */ +static void main_thread_func (uint32_t data); + + +/** + * \b main + * + * Program entry point. + * + * Sets up the AVR hardware resources (system tick timer interrupt) necessary + * for the OS to be started. Creates an application thread and starts the OS. + */ + +int main ( void ) +{ + int8_t status; + + /** + * Note: to protect OS structures and data during initialisation, + * interrupts must remain disabled until the first thread + * has been restored. They are reenabled at the very end of + * the first thread restore, at which point it is safe for a + * reschedule to take place. + */ + + /* Initialise the OS before creating our threads */ + status = atomOSInit(&idle_thread_stack[0], IDLE_STACK_SIZE_BYTES, TRUE); + if (status == ATOM_OK) + { + /* Enable the system tick timer */ + mips_cpu_timer_enable(); + mips_setup_interrupts(); + + /* Create an application thread */ + status = atomThreadCreate(&main_tcb, + TEST_THREAD_PRIO, main_thread_func, 0, + &main_thread_stack[0], + MAIN_STACK_SIZE_BYTES, + TRUE); + if (status == ATOM_OK) + { + /** + * First application thread successfully created. It is + * now possible to start the OS. Execution will not return + * from atomOSStart(), which will restore the context of + * our application thread and start executing it. + * + * Note that interrupts are still disabled at this point. + * They will be enabled as we restore and execute our first + * thread in archFirstThreadRestore(). + */ + atomOSStart(); + } + } + + while (1) + ; + + /* There was an error starting the OS if we reach here */ + return (0); +} + + +/** + * \b main_thread_func + * + * Entry point for main application thread. + * + * This is the first thread that will be executed when the OS is started. + * + * @param[in] data Unused (optional thread entry parameter) + * + * @return None + */ +static void main_thread_func (uint32_t data) +{ + uint32_t test_status; + + /* Initialise UART */ + init_console(); + + /* Put a message out on the UART */ + printk ("Go\n"); + + /* Start test. All tests use the same start API. */ + test_status = test_start(); + + /* Check main thread stack usage (if enabled) */ +#ifdef ATOM_STACK_CHECKING + if (test_status == 0) + { + uint32_t used_bytes, free_bytes; + + /* Check idle thread stack usage */ + if (atomThreadStackCheck (&main_tcb, &used_bytes, &free_bytes) == ATOM_OK) + { + /* Check the thread did not use up to the end of stack */ + if (free_bytes == 0) + { + printk ("Main stack overflow\n"); + test_status++; + } + + /* Log the stack usage */ +#ifdef TESTS_LOG_STACK_USAGE + printk ("MainUse:%d\n", used_bytes); +#endif + } + + } +#endif + + /* Log final status */ + if (test_status == 0) + { + printk ("Pass\n"); + } + else + { + printk ("Fail(%d)\n", test_status); + } + + /* Test finished, loop forever */ + while (1) + { + /* Sleep */ + atomTimerDelay (1); + } + +} diff --git a/ports/mips/vsprintf.c b/ports/mips/vsprintf.c new file mode 100644 index 0000000..6d58e1b --- /dev/null +++ b/ports/mips/vsprintf.c @@ -0,0 +1,244 @@ +/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */ +/* + * Wirzenius wrote this portably, Torvalds fucked it up :-) + * and Himanshu Fucked it up further :)) + */ + +#include +#include "system.h" +#include "atomport.h" + +/* we use this so that we can do without the ctype library */ +#define is_digit(c) ((c) >= '0' && (c) <= '9') + +static int skip_atoi(const int8_t **s) +{ + int i=0; + + while (is_digit(**s)) + i = i*10 + *((*s)++) - '0'; + return i; +} + +#define ZEROPAD 1 /* pad with zero */ +#define SIGN 2 /* unsigned/signed long */ +#define PLUS 4 /* show plus */ +#define SPACE 8 /* space if plus */ +#define LEFT 16 /* left justified */ +#define SPECIAL 32 /* 0x */ +#define SMALL 64 /* use 'abcdef' instead of 'ABCDEF' */ + +/*#define do_div(n,base) ({ \ +int __res; \ +__asm__("divl %4":"=a" (n),"=d" (__res):"0" (n),"1" (0),"r" (base)); \ +__res; })*/ + +static uint32_t do_div (int32_t *n, int32_t base) +{ + uint32_t remainder = *n % base; + *n /= base; + return remainder; +} + +static int8_t * number(int8_t * str, int32_t num, int32_t base, + int32_t size, int32_t precision, int32_t type) +{ + int8_t c,sign,tmp[36]; + const int8_t *digits=(const int8_t *)"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"; + int32_t i; + + if (type & SMALL) digits = (const int8_t *)"0123456789abcdefghijklmnopqrstuvwxyz"; + if (type & LEFT) type &= ~ZEROPAD; + if (base < 2 || base > 36) + return 0; + c = (type & ZEROPAD) ? '0' : ' ' ; + if (type & SIGN && num < 0) { + sign = '-'; + num = -num; + } else + sign = (type & PLUS) ? '+' : ((type & SPACE) ? ' ' : 0); + if (sign) size--; + + if (type & SPECIAL) { + if (base == 16) { + size -= 2; + } else if (base == 8) { + size--; + } + } + + i = 0; + if (num == 0) + tmp[i++] = '0'; + else while (num != 0) + tmp[i++] = digits[do_div(&num,base)]; + if (i > precision) precision = i; + size -= precision; + if (!(type & (ZEROPAD + LEFT))) + while(size-- > 0) + *str++ = ' '; + if (sign) + *str++ = sign; + if (type & SPECIAL) { + if (base == 8) { + *str++ = '0'; + } else if (base == 16) { + *str++ = '0'; + *str++ = digits[33]; + } + } + + if (!(type & LEFT)) + while(size-- > 0) + *str++ = c; + while(i < precision--) + *str++ = '0'; + while(i-- > 0) + *str++ = tmp[i]; + while(size-- > 0) + *str++ = ' '; + return str; +} + +int vsprintf (int8_t *buf, const int8_t *fmt, va_list args) +{ + int32_t len; + int32_t i; + int8_t * str; + int8_t *s; + int32_t *ip; + + int32_t flags; /* flags to number() */ + + int32_t field_width; /* width of output field */ + int32_t precision; /* min. # of digits for integers; max + number of chars for from string */ + int32_t qualifier; /* 'h', 'l', or 'L' for integer fields */ + + for (str=buf ; *fmt ; ++fmt) { + if (*fmt != '%') { + *str++ = *fmt; + continue; + } + + /* process flags */ + flags = 0; + repeat: + ++fmt; /* this also skips first '%' */ + switch (*fmt) { + case '-': flags |= LEFT; goto repeat; + case '+': flags |= PLUS; goto repeat; + case ' ': flags |= SPACE; goto repeat; + case '#': flags |= SPECIAL; goto repeat; + case '0': flags |= ZEROPAD; goto repeat; + } + + /* get field width */ + field_width = -1; + if (is_digit(*fmt)) + field_width = skip_atoi(&fmt); + else if (*fmt == '*') { + /* it's the next argument */ + field_width = va_arg(args, int); + if (field_width < 0) { + field_width = -field_width; + flags |= LEFT; + } + } + + /* get the precision */ + precision = -1; + if (*fmt == '.') { + ++fmt; + if (is_digit(*fmt)) + precision = skip_atoi(&fmt); + else if (*fmt == '*') { + /* it's the next argument */ + precision = va_arg(args, int); + } + if (precision < 0) + precision = 0; + } + + /* get the conversion qualifier */ + qualifier = -1; + if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L') { + qualifier = *fmt; + ++fmt; + } + + switch (*fmt) { + case 'c': + if (!(flags & LEFT)) + while (--field_width > 0) + *str++ = ' '; + *str++ = (unsigned char) va_arg(args, int); + while (--field_width > 0) + *str++ = ' '; + break; + + case 's': + s = va_arg(args, int8_t *); + len = strlen(s); + if (precision < 0) + precision = len; + else if (len > precision) + len = precision; + + if (!(flags & LEFT)) + while (len < field_width--) + *str++ = ' '; + for (i = 0; i < len; ++i) + *str++ = *s++; + while (len < field_width--) + *str++ = ' '; + break; + + case 'o': + str = number(str, va_arg(args, unsigned long), 8, + field_width, precision, flags); + break; + + case 'p': + if (field_width == -1) { + field_width = 8; + flags |= ZEROPAD; + } + str = number(str, + (unsigned long) va_arg(args, void *), 16, + field_width, precision, flags); + break; + + case 'x': + flags |= SMALL; + case 'X': + str = number(str, va_arg(args, unsigned long), 16, + field_width, precision, flags); + break; + + case 'd': + case 'i': + flags |= SIGN; + case 'u': + str = number(str, va_arg(args, unsigned long), 10, + field_width, precision, flags); + break; + + case 'n': + ip = va_arg(args, int32_t *); + *ip = (str - buf); + break; + + default: + if (*fmt != '%') + *str++ = '%'; + if (*fmt) + *str++ = *fmt; + else + --fmt; + break; + } + } + *str = '\0'; + return str-buf; +} From a96a1afbc7659e051d41289e9d056359e1f98197 Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Tue, 19 Jul 2011 21:54:29 +0100 Subject: [PATCH 5/8] Remove AVR-specific comments from MIPS Makefile. --- ports/mips/Makefile | 3 --- 1 file changed, 3 deletions(-) diff --git a/ports/mips/Makefile b/ports/mips/Makefile index 04d340b..2254250 100644 --- a/ports/mips/Makefile +++ b/ports/mips/Makefile @@ -4,9 +4,6 @@ # Build all test applications: # make -# -# Program a test application using UISP (appname => test app e.g. sems1): -# make program app=appname # Location of build tools and atomthreads sources KERNEL_DIR=../../kernel From d64a52452225dbe17198414a2e9ad52f6fc56da0 Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Tue, 19 Jul 2011 21:56:07 +0100 Subject: [PATCH 6/8] Add qemu/ddd instructions to MIPS readme. --- ports/mips/README | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/ports/mips/README b/ports/mips/README index 5f778c8..d0ca2af 100644 --- a/ports/mips/README +++ b/ports/mips/README @@ -1,3 +1,8 @@ * Required Ubuntu packages: qemu, qemu-kvm-extras + * Lucid 0.12.3 no good, better to install from source, make && sudo make install * Compiler: CodeSourcery * Run test: qemu-system-mips -M mips -m 128 -kernel build/kern1.elf -nographic + + * GDB: Add -S -s to qemu startup + * mips-linux-gnu-gdb, target remote localhost:1234, file build/mutex5.elf + * ddd ---debugger mips-linux-gnu-gdb build/mutex5.elf From fc53574c1275bb99f3d8e20f0df7e4ec3b0531ca Mon Sep 17 00:00:00 2001 From: Kelvin Lawson Date: Tue, 19 Jul 2011 22:53:30 +0100 Subject: [PATCH 7/8] Remove TODO, functionality completed. --- ports/mips/atomport-tests.h | 1 - 1 file changed, 1 deletion(-) diff --git a/ports/mips/atomport-tests.h b/ports/mips/atomport-tests.h index 4b44513..0c73b36 100644 --- a/ports/mips/atomport-tests.h +++ b/ports/mips/atomport-tests.h @@ -37,7 +37,6 @@ #include "printk.h" /* Logger macro for viewing test results */ -/* FIXME: Add uart out routine once uart is supported */ #define ATOMLOG printk #define _STR From 48fe6bc12aff3dc9381659458304c2f84f3149d4 Mon Sep 17 00:00:00 2001 From: Himanshu Chauhan Date: Fri, 22 Jul 2011 23:36:17 +0530 Subject: [PATCH 8/8] Fixed Context switch and timer-delay problem with MIPS. Signed-off-by: Himanshu Chauhan --- ports/mips/atomport-asm-macros.h | 123 +++++++++++++------------ ports/mips/atomport-asm.s | 151 +++++++++---------------------- ports/mips/atomport-entry.s | 26 +----- ports/mips/atomport-timer.c | 9 +- ports/mips/atomport.c | 8 +- ports/mips/atomport.h | 15 +-- ports/mips/regs.h | 4 + 7 files changed, 127 insertions(+), 209 deletions(-) diff --git a/ports/mips/atomport-asm-macros.h b/ports/mips/atomport-asm-macros.h index 39b9bb6..137285a 100644 --- a/ports/mips/atomport-asm-macros.h +++ b/ports/mips/atomport-asm-macros.h @@ -47,7 +47,7 @@ fn: nop; \ nop; -#define enable_global_interrupts ei $0 +#define enable_global_interrupts ei #define disable_global_interrupts di $0 #define EXCEPTION_VECTOR(_name, _offset, _where)\ @@ -63,70 +63,69 @@ _name: \ #define LOAD_REG(reg, treg) \ lw reg, ((reg ## _IDX) * 4)(treg) -#define SAVE_INT_CONTEXT \ - addiu sp, sp, -((NUM_REGISTERS + 1)* 4); \ +#define SAVE_INT_CONTEXT(treg) \ mfc0 k1, CP0_EPC; \ - SAVE_REG(t0,sp); \ - SAVE_REG(t1,sp); \ - SAVE_REG(t2,sp); \ - SAVE_REG(t3,sp); \ - SAVE_REG(t4,sp); \ - SAVE_REG(t5,sp); \ - SAVE_REG(t6,sp); \ - SAVE_REG(t7,sp); \ - SAVE_REG(t8,sp); \ - SAVE_REG(t9,sp); \ - SAVE_REG(v0,sp); \ - SAVE_REG(v1,sp); \ - SAVE_REG(a0,sp); \ - SAVE_REG(a1,sp); \ - SAVE_REG(a2,sp); \ - SAVE_REG(a3,sp); \ - SAVE_REG(s0,sp); \ - SAVE_REG(s1,sp); \ - SAVE_REG(s2,sp); \ - SAVE_REG(s3,sp); \ - SAVE_REG(s4,sp); \ - SAVE_REG(s5,sp); \ - SAVE_REG(s6,sp); \ - SAVE_REG(s7,sp); \ - SAVE_REG(gp,sp); \ - SAVE_REG(s8,sp); \ - SAVE_REG(ra,sp); \ - sw k0, (sp_IDX * 4)(sp); \ - sw k1, (NUM_REGISTERS * 4)(sp); + SAVE_REG(t0,treg); \ + SAVE_REG(t1,treg); \ + SAVE_REG(t2,treg); \ + SAVE_REG(t3,treg); \ + SAVE_REG(t4,treg); \ + SAVE_REG(t5,treg); \ + SAVE_REG(t6,treg); \ + SAVE_REG(t7,treg); \ + SAVE_REG(t8,treg); \ + SAVE_REG(t9,treg); \ + SAVE_REG(v0,treg); \ + SAVE_REG(v1,treg); \ + SAVE_REG(a0,treg); \ + SAVE_REG(a1,treg); \ + SAVE_REG(a2,treg); \ + SAVE_REG(a3,treg); \ + SAVE_REG(s0,treg); \ + SAVE_REG(s1,treg); \ + SAVE_REG(s2,treg); \ + SAVE_REG(s3,treg); \ + SAVE_REG(s4,treg); \ + SAVE_REG(s5,treg); \ + SAVE_REG(s6,treg); \ + SAVE_REG(s7,treg); \ + SAVE_REG(gp,treg); \ + SAVE_REG(s8,treg); \ + SAVE_REG(ra,treg); \ + sw k0, (sp_IDX * 4)(treg); \ + sw k1, (cp0_epc_IDX * 4)(treg); -#define RESTORE_INT_CONTEXT \ - lw k1, (NUM_REGISTERS * 4)(sp); \ +#define RESTORE_INT_CONTEXT(treg) \ + lw k1, (cp0_epc_IDX * 4)(treg); \ mtc0 k1, CP0_EPC; \ - LOAD_REG(s0,sp); \ - LOAD_REG(s1,sp); \ - LOAD_REG(s2,sp); \ - LOAD_REG(s3,sp); \ - LOAD_REG(s4,sp); \ - LOAD_REG(s5,sp); \ - LOAD_REG(s6,sp); \ - LOAD_REG(s7,sp); \ - LOAD_REG(v0,sp); \ - LOAD_REG(v1,sp); \ - LOAD_REG(a0,sp); \ - LOAD_REG(a1,sp); \ - LOAD_REG(a2,sp); \ - LOAD_REG(a3,sp); \ - LOAD_REG(t0,sp); \ - LOAD_REG(t1,sp); \ - LOAD_REG(t2,sp); \ - LOAD_REG(t3,sp); \ - LOAD_REG(t4,sp); \ - LOAD_REG(t5,sp); \ - LOAD_REG(t6,sp); \ - LOAD_REG(t7,sp); \ - LOAD_REG(t8,sp); \ - LOAD_REG(t9,sp); \ - LOAD_REG(gp,sp); \ - LOAD_REG(ra,sp); \ - LOAD_REG(s8,sp); \ - lw sp, (sp_IDX * 4)(sp); + LOAD_REG(s0,treg); \ + LOAD_REG(s1,treg); \ + LOAD_REG(s2,treg); \ + LOAD_REG(s3,treg); \ + LOAD_REG(s4,treg); \ + LOAD_REG(s5,treg); \ + LOAD_REG(s6,treg); \ + LOAD_REG(s7,treg); \ + LOAD_REG(v0,treg); \ + LOAD_REG(v1,treg); \ + LOAD_REG(a0,treg); \ + LOAD_REG(a1,treg); \ + LOAD_REG(a2,treg); \ + LOAD_REG(a3,treg); \ + LOAD_REG(t0,treg); \ + LOAD_REG(t1,treg); \ + LOAD_REG(t2,treg); \ + LOAD_REG(t3,treg); \ + LOAD_REG(t4,treg); \ + LOAD_REG(t5,treg); \ + LOAD_REG(t6,treg); \ + LOAD_REG(t7,treg); \ + LOAD_REG(t8,treg); \ + LOAD_REG(t9,treg); \ + LOAD_REG(gp,treg); \ + LOAD_REG(ra,treg); \ + LOAD_REG(s8,treg); \ + lw sp, (sp_IDX * 4)(treg); #endif /* __ASSEMBLY__ */ diff --git a/ports/mips/atomport-asm.s b/ports/mips/atomport-asm.s index 2b64746..931ee9e 100644 --- a/ports/mips/atomport-asm.s +++ b/ports/mips/atomport-asm.s @@ -31,9 +31,6 @@ .section .text -.extern atomCurrentContext -.extern at_preempt_count - /** * Function that performs the contextSwitch. Whether its a voluntary release * of CPU by thread or a pre-emption, under both conditions this function is @@ -43,121 +40,49 @@ */ .globl archContextSwitch archContextSwitch: - /* - * Check if we are being called in interrupt - * context. If yes, we need to restore complete - * context and return directly from here. - */ - move k0, ra - bal atomCurrentContext - nop - beq v0, zero, __in_int_context - nop - - move ra, k0 move v0, a0 /* return old tcb when we return from here */ lw k0, 0(a0) /* assume that sp_save_ptr is always at base of ATOM_TCB */ - sw s0, (s0_IDX * 4)(k0) - sw s1, (s1_IDX * 4)(k0) - sw s2, (s2_IDX * 4)(k0) - sw s3, (s3_IDX * 4)(k0) - sw s4, (s4_IDX * 4)(k0) - sw s5, (s5_IDX * 4)(k0) - sw s6, (s6_IDX * 4)(k0) - sw s7, (s7_IDX * 4)(k0) - sw s8, (s8_IDX * 4)(k0) - sw sp, (sp_IDX * 4)(k0) - sw gp, (gp_IDX * 4)(k0) - sw ra, (ra_IDX * 4)(k0) - /* - * We are saving registers in non-interrupt context because - * a thread probably is trying to yield CPU. Storing zero - * in EPC offset differentiates this. When restoring the - * context, if EPC offset has zero we will restore only - * the partial context. Rest will be done by GCC while - * unwinding the call. - */ - sw zero, (cp0_epc_IDX * 4)(k0) + SAVE_REG(s0, k0) + SAVE_REG(s1, k0) + SAVE_REG(s2, k0) + SAVE_REG(s3, k0) + SAVE_REG(s4, k0) + SAVE_REG(s5, k0) + SAVE_REG(s6, k0) + SAVE_REG(s7, k0) + SAVE_REG(s8, k0) + SAVE_REG(sp, k0) + SAVE_REG(gp, k0) + SAVE_REG(ra, k0) lw k1, 0(a1) + LOAD_REG(s0, k1) + LOAD_REG(s1, k1) + LOAD_REG(s2, k1) + LOAD_REG(s3, k1) + LOAD_REG(s4, k1) + LOAD_REG(s5, k1) + LOAD_REG(s6, k1) + LOAD_REG(s7, k1) + LOAD_REG(s8, k1) + LOAD_REG(sp, k1) + LOAD_REG(gp, k1) + LOAD_REG(ra, k1) + lw k0, (cp0_epc_IDX * 4)(k1) - bnez k0, __unwind_int_context + bnez k0, 1f nop - - lw s0, (s0_IDX * 4)(k1) - lw s1, (s1_IDX * 4)(k1) - lw s2, (s2_IDX * 4)(k1) - lw s3, (s3_IDX * 4)(k1) - lw s4, (s4_IDX * 4)(k1) - lw s5, (s5_IDX * 4)(k1) - lw s6, (s6_IDX * 4)(k1) - lw s7, (s7_IDX * 4)(k1) - lw s8, (s8_IDX * 4)(k1) - lw sp, (sp_IDX * 4)(k1) - lw gp, (gp_IDX * 4)(k1) - lw ra, (ra_IDX * 4)(k1) - + li k0, 0x00000001 + sw k0, (cp0_epc_IDX * 4)(k1) + LOAD_REG(a0, k1) + LOAD_REG(a1, k1) + LOAD_REG(a2, k1) + LOAD_REG(a3, k1) + enable_global_interrupts +1: jr ra nop -__in_int_context: - move ra, k0 - /* - * In interrupt context, the interrupt handler - * saves the context for us. Its very well there - * and we don't need to do it again. - * - * We will figure out of the task that we are - * switching in was saved in interrupt context - * or otherwise. - */ - lw k0, (cp0_epc_IDX * 4)(k1) - bnez k0, __unwind_int_context - nop - - /* - * Unwinding a task switched in non-interrupt context. - * So, restore only the partials. But since we are in - * interrupt mode, we will put ra in epc and do a eret - * so that we get out of interrupt mode and switch to - * the new task. - */ -__unwind_non_int_context: - lw s0, (s0_IDX * 4)(k1) - lw s1, (s1_IDX * 4)(k1) - lw s2, (s2_IDX * 4)(k1) - lw s3, (s3_IDX * 4)(k1) - lw s4, (s4_IDX * 4)(k1) - lw s5, (s5_IDX * 4)(k1) - lw s6, (s6_IDX * 4)(k1) - lw s7, (s7_IDX * 4)(k1) - lw s8, (s8_IDX * 4)(k1) - lw sp, (sp_IDX * 4)(k1) - lw gp, (gp_IDX * 4)(k1) - lw ra, (ra_IDX * 4)(k1) - mtc0 ra, CP0_EPC - nop - nop - nop - j __ret_from_switch - nop - -__unwind_int_context: - move sp, k1 - RESTORE_INT_CONTEXT - -__ret_from_switch: - la k0, at_preempt_count - lw k1, (k0) - addi k1, k1, -1 - sw k1, (k0) - bnez k1, __return_from_int - nop - enable_global_interrupts - ehb -__return_from_int: - eret - /** * archFirstThreadRestore(ATOM_TCB *new_tcb) * @@ -182,5 +107,13 @@ archFirstThreadRestore: nop nop nop + ehb + li k0, 0x00000001 + sw k0, (cp0_epc_IDX * 4)(k1) + nop + ehb enable_global_interrupts + ehb + nop + nop eret diff --git a/ports/mips/atomport-entry.s b/ports/mips/atomport-entry.s index 35b5735..f38bd10 100644 --- a/ports/mips/atomport-entry.s +++ b/ports/mips/atomport-entry.s @@ -90,32 +90,16 @@ LEAF(_handle_interrupt) beq k0, zero, 1f nop - move k0, ra - move k1, v0 - bal atomCurrentContext - nop - beq v0, zero, 2f /* v0 should be current context */ - nop - - move ra, k0 - lw k0, 0(v0) - move v0, k1 - move k1, k0 - /* - * Note that we aren't loading any new SP. Context - * will be save on the interrupted threads' stack. - */ move k0, sp - move sp, k1 - SAVE_INT_CONTEXT + /* Calculate interrupt context base */ + addi sp, sp, -(NUM_CTX_REGS * WORD_SIZE) + SAVE_INT_CONTEXT(sp) bal handle_mips_systick nop - RESTORE_INT_CONTEXT -1: + RESTORE_INT_CONTEXT(sp) +1: enable_global_interrupts eret - -2: b 2b END(_handle_interrupt) LEAF(_handle_cache_error) diff --git a/ports/mips/atomport-timer.c b/ports/mips/atomport-timer.c index 3997a29..a1e2e02 100644 --- a/ports/mips/atomport-timer.c +++ b/ports/mips/atomport-timer.c @@ -54,14 +54,19 @@ void mips_cpu_timer_enable(void) void handle_mips_systick(void) { + /* clear EXL from status */ + uint32_t sr = read_c0_status(); + sr &= ~0x00000002; + write_c0_status(sr); + /* Call the interrupt entry routine */ atomIntEnter(); /* Call the OS system tick handler */ atomTimerTick(); + write_c0_compare(read_c0_count() + COUNTER_TICK_COUNT); + /* Call the interrupt exit routine */ atomIntExit(TRUE); - - write_c0_compare(read_c0_count() + COUNTER_TICK_COUNT); } diff --git a/ports/mips/atomport.c b/ports/mips/atomport.c index 0af7f71..95301a6 100644 --- a/ports/mips/atomport.c +++ b/ports/mips/atomport.c @@ -31,7 +31,7 @@ #include #include #include -#include "regs.h" +#include #include @@ -58,11 +58,11 @@ void archThreadContextInit (ATOM_TCB *tcb_ptr, void *stack_top, void (*entry_point)(UINT32), UINT32 entry_param) { - #define STORE_VAL(base, reg, val) \ *((uint32_t *)(base + ((reg ## _IDX) * WORD_SIZE))) = (uint32_t)val - uint32_t stack_start = (uint32_t)(stack_top - (WORD_SIZE * (NUM_REGISTERS + 1))); + /* Make space for context saving */ + uint32_t stack_start = (uint32_t)(stack_top - (WORD_SIZE * NUM_CTX_REGS)); tcb_ptr->sp_save_ptr = (void *)stack_start; @@ -75,7 +75,7 @@ void archThreadContextInit (ATOM_TCB *tcb_ptr, void *stack_top, STORE_VAL(stack_start, s5, 0); STORE_VAL(stack_start, s6, 0); STORE_VAL(stack_start, s7, 0); - STORE_VAL(stack_start, cp0_epc, entry_point); + STORE_VAL(stack_start, cp0_epc, 0); STORE_VAL(stack_start, ra, entry_point); STORE_VAL(stack_start, a0, entry_param); } diff --git a/ports/mips/atomport.h b/ports/mips/atomport.h index b7a6832..6145df1 100644 --- a/ports/mips/atomport.h +++ b/ports/mips/atomport.h @@ -72,21 +72,14 @@ extern uint32_t at_preempt_count; __asm__ __volatile__("di %0\t\n" \ "ehb\t\n" \ :"=r"(status_reg)); \ - at_preempt_count++; \ }while(0); #define CRITICAL_END() \ do { \ - at_preempt_count--; \ - \ - if (at_preempt_count == 0) { \ - if (atomCurrentContext()) { \ - __asm__ __volatile__("ei %0\t\n" \ - "ehb\t\n" \ - ::"r"(status_reg));\ - } \ - } \ - \ + __asm__ __volatile__("mtc0 %0, $12\t\n" \ + "nop\t\n" \ + "ehb\t\n" \ + ::"r"(status_reg)); \ }while(0); /* Uncomment to enable stack-checking */ diff --git a/ports/mips/regs.h b/ports/mips/regs.h index ecf77d5..4e0d9e0 100644 --- a/ports/mips/regs.h +++ b/ports/mips/regs.h @@ -101,6 +101,10 @@ #define at_IDX 30 #define zero_IDX 31 #define cp0_epc_IDX 32 +#define cp0_status_IDX 33 +#define cp_cause_IDX 34 + +#define NUM_CTX_REGS 35 #define CP0_INDEX $0 #define CP0_RANDOM $1