]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/message_buffer.h
Correct code comments that referred to taskYIELD_FROM_ISR to portYIELD_FROM_ISR.
[freertos] / FreeRTOS / Source / include / message_buffer.h
index 8ee6ef004e74ccacd86a7052de7ccff33f94e9de..745f0b6135fa12dae51f1acb1d16c75cfe9ed7af 100644 (file)
@@ -1,6 +1,6 @@
 /*\r
- * FreeRTOS Kernel V10.1.0\r
- * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
+ * FreeRTOS Kernel V10.2.1\r
+ * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
  *\r
  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
  * this software and associated documentation files (the "Software"), to deal in\r
 #ifndef FREERTOS_MESSAGE_BUFFER_H\r
 #define FREERTOS_MESSAGE_BUFFER_H\r
 \r
+#ifndef INC_FREERTOS_H\r
+       #error "include FreeRTOS.h must appear in source files before include message_buffer.h"\r
+#endif\r
+\r
 /* Message buffers are built onto of stream buffers. */\r
 #include "stream_buffer.h"\r
 \r
@@ -395,10 +399,10 @@ BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.
     // priority of the currently executing task was unblocked and a context\r
     // switch should be performed to ensure the ISR returns to the unblocked\r
     // task.  In most FreeRTOS ports this is done by simply passing\r
-    // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
+    // xHigherPriorityTaskWoken into portYIELD_FROM_ISR(), which will test the\r
     // variables value, and perform the context switch if necessary.  Check the\r
     // documentation for the port in use for port specific instructions.\r
-    taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
+    portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 }\r
 </pre>\r
  * \defgroup xMessageBufferSendFromISR xMessageBufferSendFromISR\r
@@ -584,10 +588,10 @@ BaseType_t xHigherPriorityTaskWoken = pdFALSE;  // Initialised to pdFALSE.
     // priority of the currently executing task was unblocked and a context\r
     // switch should be performed to ensure the ISR returns to the unblocked\r
     // task.  In most FreeRTOS ports this is done by simply passing\r
-    // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
+    // xHigherPriorityTaskWoken into portYIELD_FROM_ISR(), which will test the\r
     // variables value, and perform the context switch if necessary.  Check the\r
     // documentation for the port in use for port specific instructions.\r
-    taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
+    portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 }\r
 </pre>\r
  * \defgroup xMessageBufferReceiveFromISR xMessageBufferReceiveFromISR\r
@@ -692,6 +696,7 @@ size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer ) );
  * \ingroup MessageBufferManagement\r
  */\r
 #define xMessageBufferSpaceAvailable( xMessageBuffer ) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer )\r
+#define xMessageBufferSpacesAvailable( xMessageBuffer ) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer ) /* Corrects typo in original macro name. */\r
 \r
 /**\r
  * message_buffer.h\r