Added a note to sleep functions because use of unsafe time conversion macros internally.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10170 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
Giovanni Di Sirio 2017-04-24 16:48:14 +00:00
parent 17c5e83f03
commit 11cd580360
1 changed files with 9 additions and 0 deletions

View File

@ -182,6 +182,9 @@ typedef struct {
* @note The specified time is rounded up to a value allowed by the real
* system tick clock.
* @note The maximum specifiable value is implementation dependent.
* @note Use of this macro for large values is not secure because
* integer overflows, make sure your value can be correctly
* converted.
*
* @param[in] sec time in seconds, must be different from zero
*
@ -195,6 +198,9 @@ typedef struct {
* @note The specified time is rounded up to a value allowed by the real
* system tick clock.
* @note The maximum specifiable value is implementation dependent.
* @note Use of this macro for large values is not secure because
* integer overflows, make sure your value can be correctly
* converted.
*
* @param[in] msec time in milliseconds, must be different from zero
*
@ -208,6 +214,9 @@ typedef struct {
* @note The specified time is rounded up to a value allowed by the real
* system tick clock.
* @note The maximum specifiable value is implementation dependent.
* @note Use of this macro for large values is not secure because
* integer overflows, make sure your value can be correctly
* converted.
*
* @param[in] usec time in microseconds, must be different from zero
*