]> git.sur5r.net Git - freertos/blobdiff - Source/include/task.h
Again, just corrected some comments.
[freertos] / Source / include / task.h
index 7f4540eaf730a2209bc4dbca02052ffd46dd8ff4..30f3bf40ae052dae8e61dee4e03075881fe92d85 100644 (file)
@@ -1,41 +1,46 @@
 /*\r
-    FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.\r
+    FreeRTOS V6.0.1 - Copyright (C) 2009 Real Time Engineers Ltd.\r
+\r
+    ***************************************************************************\r
+    *                                                                         *\r
+    * If you are:                                                             *\r
+    *                                                                         *\r
+    *    + New to FreeRTOS,                                                   *\r
+    *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
+    *    + Looking for basic training,                                        *\r
+    *    + Wanting to improve your FreeRTOS skills and productivity           *\r
+    *                                                                         *\r
+    * then take a look at the FreeRTOS eBook                                  *\r
+    *                                                                         *\r
+    *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
+    *                  http://www.FreeRTOS.org/Documentation                  *\r
+    *                                                                         *\r
+    * A pdf reference manual is also available.  Both are usually delivered   *\r
+    * to your inbox within 20 minutes to two hours when purchased between 8am *\r
+    * and 8pm GMT (although please allow up to 24 hours in case of            *\r
+    * exceptional circumstances).  Thank you for your support!                *\r
+    *                                                                         *\r
+    ***************************************************************************\r
 \r
     This file is part of the FreeRTOS distribution.\r
 \r
-    FreeRTOS is free software; you can redistribute it and/or modify it    under\r
+    FreeRTOS is free software; you can redistribute it and/or modify it under\r
     the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation and modified by the FreeRTOS exception.\r
-    **NOTE** The exception to the GPL is included to allow you to distribute a\r
-    combined work that includes FreeRTOS without being obliged to provide the\r
+    Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
+    ***NOTE*** The exception to the GPL is included to allow you to distribute\r
+    combined work that includes FreeRTOS without being obliged to provide the\r
     source code for proprietary components outside of the FreeRTOS kernel.\r
-    Alternative commercial license and support terms are also available upon\r
-    request.  See the licensing section of http://www.FreeRTOS.org for full\r
-    license details.\r
-\r
-    FreeRTOS is distributed in the hope that it will be useful,    but WITHOUT\r
+    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
-    more details.\r
-\r
-    You should have received a copy of the GNU General Public License along\r
-    with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
-    Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
-\r
-\r
-    ***************************************************************************\r
-    *                                                                         *\r
-    * The FreeRTOS eBook and reference manual are available to purchase for a *\r
-    * small fee. Help yourself get started quickly while also helping the     *\r
-    * FreeRTOS project! See http://www.FreeRTOS.org/Documentation for details *\r
-    *                                                                         *\r
-    ***************************************************************************\r
+    more details. You should have received a copy of the GNU General Public \r
+    License and the FreeRTOS license exception along with FreeRTOS; if not it \r
+    can be viewed here: http://www.freertos.org/a00114.html and also obtained \r
+    by writing to Richard Barry, contact details for whom are available on the\r
+    FreeRTOS WEB site.\r
 \r
     1 tab == 4 spaces!\r
 \r
-    Please ensure to read the configuration and relevant port sections of the\r
-    online documentation.\r
-\r
     http://www.FreeRTOS.org - Documentation, latest information, license and\r
     contact details.\r
 \r
@@ -67,7 +72,7 @@ extern "C" {
  * MACROS AND DEFINITIONS\r
  *----------------------------------------------------------*/\r
 \r
-#define tskKERNEL_VERSION_NUMBER "V6.0.0"\r
+#define tskKERNEL_VERSION_NUMBER "V6.0.1"\r
 \r
 /**\r
  * task. h\r
@@ -254,7 +259,7 @@ typedef struct xTASK_PARAMTERS
         // Create the task, storing the handle.  Note that the passed parameter ucParameterToPass\r
         // must exist for the lifetime of the task, so in this case is declared static.  If it was just an\r
         // an automatic stack variable it might no longer exist, or at least have been corrupted, by the time\r
-        // the new time attempts to access it.\r
+        // the new task attempts to access it.\r
         xTaskCreate( vTaskCode, "NAME", STACK_SIZE, &ucParameterToPass, tskIDLE_PRIORITY, &xHandle );\r
 \r
         // Use the handle to delete the task.\r
@@ -269,7 +274,7 @@ typedef struct xTASK_PARAMTERS
 /**\r
  * task. h\r
  *<pre>\r
- portBASE_TYPE xTaskCreateRestricted( xTaskParameters *pxTaskDefinition, xTaskHandle pxCreatedTask );</pre>\r
+ portBASE_TYPE xTaskCreateRestricted( xTaskParameters *pxTaskDefinition, xTaskHandle *pxCreatedTask );</pre>\r
  *\r
  * xTaskCreateRestricted() should only be used in systems that include an MPU\r
  * implementation.\r
@@ -283,10 +288,6 @@ typedef struct xTASK_PARAMTERS
  * documentation) plus an optional stack buffer and the memory region \r
  * definitions.\r
  *\r
- * @param pcName A descriptive name for the task.  This is mainly used to\r
- * facilitate debugging.  Max length defined by tskMAX_TASK_NAME_LEN - default\r
- * is 16.\r
- *\r
  * @param pxCreatedTask Used to pass back a handle by which the created task\r
  * can be referenced.\r
  *\r
@@ -1249,7 +1250,7 @@ void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder ) PRIVILEGED_FUN
 \r
 /*\r
  * Generic version of the task creation function which is in turn called by the\r
- * xTaskCreate() and xTaskCreateProtected() macros.\r
+ * xTaskCreate() and xTaskCreateRestricted() macros.\r
  */\r
 signed portBASE_TYPE xTaskGenericCreate( pdTASK_CODE pvTaskCode, const signed char * const pcName, unsigned short usStackDepth, void *pvParameters, unsigned portBASE_TYPE uxPriority, xTaskHandle *pxCreatedTask, portSTACK_TYPE *puxStackBuffer, const xMemoryRegion * const xRegions ) PRIVILEGED_FUNCTION;\r
 \r