git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@566 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 8 insertions, 1 deletions

diff --git a/src/templates/chcore.c b/src/templates/chcore.c
index c15f1c490..5a887d6ed 100644
--- a/src/templates/chcore.c
+++ b/src/templates/chcore.c
@@ -88,12 +88,19 @@ void chSysUnlock(void) {
 }

 

 /**

- * Context switch.

+ * Performs a context switch.

+ * This is the most critical code in any port, this function is responsible

+ * for the context switch between 2 threads.

+ * @param otp the thread to be switched out

+ * @param ntp the thread to be switched in

+ * @note The implementation of this code affects <b>directly</b> the context

+ *       switch performance so optimize here as much as you can.

  */

 void chSysSwitchI(Thread *otp, Thread *ntp) {}

 

 /**

  * Prints a message on the system console (if any).

+ * @param msg the message to be printed on the system console

  */

 void chSysPuts(char *msg) {

 }