diff options
Diffstat (limited to 'demos/Win32-MinGW/chcore.h')
| -rw-r--r-- | demos/Win32-MinGW/chcore.h | 141 |
1 files changed, 113 insertions, 28 deletions
diff --git a/demos/Win32-MinGW/chcore.h b/demos/Win32-MinGW/chcore.h index d1f209a68..6c9bf1f7e 100644 --- a/demos/Win32-MinGW/chcore.h +++ b/demos/Win32-MinGW/chcore.h @@ -17,27 +17,40 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/*
- * Core file for MingGW32 demo project.
+/**
+ * @addtogroup WIN32SIM_CORE
+ * @{
*/
#ifndef _CHCORE_H_
#define _CHCORE_H_
-/*
- * Unique macro for the implemented architecture.
+/**
+ * Macro defining the a simulated architecture into Win32.
*/
#define CH_ARCHITECTURE_WIN32SIM
-/*
- * Base type for stack alignment.
+/**
+ * 32 bit stack alignment.
*/
typedef uint32_t stkalign_t;
+/**
+ * Generic x86 register. + */
typedef void *regx86;
-/*
- * Stack saved context.
+/**
+ * Interrupt saved context.
+ * This structure represents the stack frame saved during a preemption-capable
+ * interrupt handler.
+ */
+struct extctx {
+};
+
+/**
+ * System saved context.
+ * @note In this demo the floating point registers are not saved.
*/
struct intctx {
regx86 ebx;
@@ -47,17 +60,26 @@ struct intctx { regx86 eip;
};
+/**
+ * Platform dependent part of the @p Thread structure.
+ * This structure usually contains just the saved stack pointer defined as a
+ * pointer to a @p intctx structure.
+ */
typedef struct {
struct intctx *esp;
} Context;
#define APUSH(p, a) (p) -= sizeof(void *), *(void **)(p) = (void*)(a)
-#define SETUP_CONTEXT(workspace, wsize, pf, arg) \
-{ \
+/**
+ * Platform dependent part of the @p chThdInit() API.
+ * This code usually setup the context switching frame represented by a
+ * @p intctx structure.
+ */
+#define SETUP_CONTEXT(workspace, wsize, pf, arg) { \
uint8_t *esp = (uint8_t *)workspace + wsize; \
APUSH(esp, arg); \
- APUSH(esp, threadstart); \
+ APUSH(esp, threadexit); \
esp -= sizeof(struct intctx); \
((struct intctx *)esp)->eip = pf; \
((struct intctx *)esp)->ebx = 0; \
@@ -67,33 +89,96 @@ typedef struct { tp->p_ctx.esp = (struct intctx *)esp; \
}
-#define chSysLock()
-#define chSysUnlock()
-#define chSysEnable()
-#define chSysPuts(msg) {}
-#define chSysIRQEnterI()
-#define chSysIRQExitI()
-
-#define INT_REQUIRED_STACK 0
+/**
+ * Stack size for the system idle thread.
+ */
+#ifndef IDLE_THREAD_STACK_SIZE
+#define IDLE_THREAD_STACK_SIZE 256
+#endif
+
+/**
+ * Per-thread stack overhead for interrupts servicing, it is used in the
+ * calculation of the correct working area size.
+ * It requires stack space because the simulated "interrupt handlers" invoke
+ * Win32 APIs inside so it better have a lot of space.
+ */
+#ifndef INT_REQUIRED_STACK
+#define INT_REQUIRED_STACK 16384
+#endif
+/**
+ * Enforces a correct alignment for a stack area size value.
+ */
#define STACK_ALIGN(n) ((((n) - 1) | sizeof(stkalign_t)) + 1)
+ /**
+ * Computes the thread working area global size.
+ */
#define THD_WA_SIZE(n) STACK_ALIGN(sizeof(Thread) + \
sizeof(void *) * 2 + \
sizeof(struct intctx) + \
- (n) + \
- INT_REQUIRED_STACK)
+ sizeof(struct extctx) + \
+ (n) + (INT_REQUIRED_STACK))
+/**
+ * Macro used to allocate a thread working area aligned as both position and
+ * size.
+ */
#define WORKING_AREA(s, n) stkalign_t s[THD_WA_SIZE(n) / sizeof(stkalign_t)];
-/*
- * Stack size for the system idle thread.
+/**
+ * IRQ prologue code, inserted at the start of all IRQ handlers enabled to
+ * invoke system APIs. + */
+#define SYS_IRQ_PROLOGUE()
+
+/**
+ * IRQ epilogue code, inserted at the end of all IRQ handlers enabled to
+ * invoke system APIs.
+ */
+#define SYS_IRQ_EPILOGUE()
+
+/**
+ * Does nothing in this simulator.
+ */
+#define sys_disable()
+
+/**
+ * Does nothing in this simulator.
+ */
+#define sys_enable()
+
+/**
+ * Does nothing in this simulator.
+ */
+#define sys_disable_from_isr()
+
+/**
+ * Does nothing in this simulator.
+ */
+#define sys_enable_from_isr()
+
+/**
+ * Does nothing in this simulator.
*/
-#define IDLE_THREAD_STACK_SIZE 16384
+#define sys_wait_for_interrupt()
-msg_t _idle(void *p);
-__attribute__((fastcall)) void chSysHalt(void);
-__attribute__((fastcall)) void chSysSwitchI(Thread *otp, Thread *ntp);
-__attribute__((fastcall)) void threadstart(void);
+/**
+ * IRQ handler function modifier. + */
+#define SYS_IRQ_HANDLER
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ __attribute__((fastcall)) void sys_puts(char *msg);
+ __attribute__((fastcall)) void sys_switch(Thread *otp, Thread *ntp);
+ __attribute__((fastcall)) void sys_halt(void);
+ void threadexit(void);
+#ifdef __cplusplus
+}
+#endif
#endif /* _CHCORE_H_ */
+
+/** @} */
|