diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-14 12:15:37 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-14 12:15:37 +0000 |
commit | e97e0ca7151a4d390bbf804cd6640bf45055a452 (patch) | |
tree | 96d52e479ac60c5c7184a9507a329355b7a5c01b /os/ports/RC | |
parent | c7837bab2ee164d6bb4fb47948ee5fe33162b449 (diff) | |
download | ChibiOS-e97e0ca7151a4d390bbf804cd6640bf45055a452.tar.gz ChibiOS-e97e0ca7151a4d390bbf804cd6640bf45055a452.tar.bz2 ChibiOS-e97e0ca7151a4d390bbf804cd6640bf45055a452.zip |
Small documentation related fix in the PPC and STM8 ports.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1741 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/ports/RC')
-rw-r--r-- | os/ports/RC/STM8/chcore.h | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/os/ports/RC/STM8/chcore.h b/os/ports/RC/STM8/chcore.h index 16624fac4..54a30584f 100644 --- a/os/ports/RC/STM8/chcore.h +++ b/os/ports/RC/STM8/chcore.h @@ -53,6 +53,7 @@ typedef uint8_t stkalign_t; */
typedef void (*stm8func_t)(void);
+#if !defined(__DOXYGEN__)
/**
* @brief Interrupt saved context.
* @details This structure represents the stack frame saved during a
@@ -72,7 +73,9 @@ struct extctx { uint8_t pch;
uint8_t pcl;
};
+#endif
+#if !defined(__DOXYGEN__)
/**
* @brief System saved context.
* @details This structure represents the inner stack frame during a context
@@ -84,13 +87,25 @@ struct intctx { uint8_t _next;
stm8func_t pc; /* Function pointer sized return address. */
};
+#endif
+
+#if !defined(__DOXYGEN__)
+/**
+ * @brief Platform dependent part of the @p Thread structure.
+ * @details This structure usually contains just the saved stack pointer
+ * defined as a pointer to a @p intctx structure.
+ */
+struct context {
+ struct intctx *sp;
+};
+#endif
/**
* @brief Start context.
* @details This context is the stack organization for the trampoline code
* @p _port_thread_start().
*/
-struct startctx {
+struct stm8_startctx {
uint8_t _next;
stm8func_t ts; /* Trampoline address. */
void *arg; /* Thread argument. */
@@ -99,23 +114,14 @@ struct startctx { };
/**
- * @brief Platform dependent part of the @p Thread structure.
- * @details This structure usually contains just the saved stack pointer
- * defined as a pointer to a @p intctx structure.
- */
-struct context {
- struct intctx *sp;
-};
-
-/**
* @brief Platform dependent part of the @p chThdInit() API.
* @details This code usually setup the context switching frame represented
* by an @p intctx structure.
*/
#define SETUP_CONTEXT(workspace, wsize, pf, arg) { \
- struct startctx *scp; \
- scp = (struct startctx *)((uint8_t *)workspace + wsize - \
- sizeof(struct startctx)); \
+ struct stm8_startctx *scp; \
+ scp = (struct stm8_startctx *)((uint8_t *)workspace + wsize - \
+ sizeof(struct stm8_startctx)); \
scp->ts = _port_thread_start; \
scp->arg = arg; \
scp->pc = (stm8func_t)pf; \
|