mirror of
https://github.com/apache/nuttx.git
synced 2026-05-27 11:26:12 +08:00
include/nuttx/wdog.h: Add some additional comments.
This commit is contained in:
committed by
Abdelatif Guettouche
parent
402fb16a77
commit
f2e6e131d4
@@ -240,7 +240,7 @@
|
|||||||
<h1><big><font color="#3c34ec">
|
<h1><big><font color="#3c34ec">
|
||||||
<i>NuttX RTOS Porting Guide</i>
|
<i>NuttX RTOS Porting Guide</i>
|
||||||
</font></big></h1>
|
</font></big></h1>
|
||||||
<p>Last Updated: April 2, 2020</p>
|
<p>Last Updated: April 7, 2020</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
@@ -2948,6 +2948,10 @@ wd_start() on a given watchdog ID has any effect.
|
|||||||
<li><code>wdentry</code>. Function to call on timeout
|
<li><code>wdentry</code>. Function to call on timeout
|
||||||
<li><code>argc</code>. The number of uint32_t parameters to pass to wdentry.
|
<li><code>argc</code>. The number of uint32_t parameters to pass to wdentry.
|
||||||
<li><code>...</code>. uint32_t size parameters to pass to wdentry
|
<li><code>...</code>. uint32_t size parameters to pass to wdentry
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<b>NOTE</b>: All parameters must be of type <code>wdparm_t</code>.
|
||||||
|
</p>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|||||||
+17
-31
@@ -1,36 +1,20 @@
|
|||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
* include/nuttx/wdog.h
|
* include/nuttx/wdog.h
|
||||||
*
|
*
|
||||||
* Copyright (C) 2007-2009, 2014-2015, 2018 Gregory Nutt. All rights
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
||||||
* reserved.
|
* contributor license agreements. See the NOTICE file distributed with
|
||||||
* Author: Gregory Nutt <gnutt@nuttx.org>
|
* this work for additional information regarding copyright ownership. The
|
||||||
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
||||||
|
* "License"); you may not use this file except in compliance with the
|
||||||
|
* License. You may obtain a copy of the License at
|
||||||
*
|
*
|
||||||
* Redistribution and use in source and binary forms, with or without
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
* modification, are permitted provided that the following conditions
|
|
||||||
* are met:
|
|
||||||
*
|
*
|
||||||
* 1. Redistributions of source code must retain the above copyright
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
* notice, this list of conditions and the following disclaimer.
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
* 2. Redistributions in binary form must reproduce the above copyright
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
* notice, this list of conditions and the following disclaimer in
|
* License for the specific language governing permissions and limitations
|
||||||
* the documentation and/or other materials provided with the
|
* under the License.
|
||||||
* distribution.
|
|
||||||
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
||||||
* used to endorse or promote products derived from this software
|
|
||||||
* without specific prior written permission.
|
|
||||||
*
|
|
||||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
||||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
||||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
||||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
||||||
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
||||||
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
||||||
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
||||||
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
||||||
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
||||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
||||||
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
* POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
*
|
*
|
||||||
****************************************************************************/
|
****************************************************************************/
|
||||||
|
|
||||||
@@ -229,10 +213,12 @@ int wd_delete(WDOG_ID wdog);
|
|||||||
* on a given watchdog ID has any effect.
|
* on a given watchdog ID has any effect.
|
||||||
*
|
*
|
||||||
* Input Parameters:
|
* Input Parameters:
|
||||||
* wdog - watchdog ID
|
* wdog - Watchdog ID
|
||||||
* delay - Delay count in clock ticks
|
* delay - Delay count in clock ticks
|
||||||
* wdentry - function to call on timeout
|
* wdentry - Function to call on timeout
|
||||||
* parm1..4 - parameters to pass to wdentry
|
* parm1..4 - Parameters to pass to wdentry.
|
||||||
|
*
|
||||||
|
* NOTE: All parameters must be of type wdparm_t.
|
||||||
*
|
*
|
||||||
* Returned Value:
|
* Returned Value:
|
||||||
* Zero (OK) is returned on success; a negated errno value is return to
|
* Zero (OK) is returned on success; a negated errno value is return to
|
||||||
|
|||||||
@@ -151,10 +151,12 @@ static inline void wd_expiration(void)
|
|||||||
* on a given watchdog ID has any effect.
|
* on a given watchdog ID has any effect.
|
||||||
*
|
*
|
||||||
* Input Parameters:
|
* Input Parameters:
|
||||||
* wdog - watchdog ID
|
* wdog - Watchdog ID
|
||||||
* delay - Delay count in clock ticks
|
* delay - Delay count in clock ticks
|
||||||
* wdentry - function to call on timeout
|
* wdentry - Function to call on timeout
|
||||||
* parm1..4 - parameters to pass to wdentry
|
* parm1..4 - Parameters to pass to wdentry
|
||||||
|
*
|
||||||
|
* NOTE: All parameters must be of type wdparm_t.
|
||||||
*
|
*
|
||||||
* Returned Value:
|
* Returned Value:
|
||||||
* Zero (OK) is returned on success; a negated errno value is return to
|
* Zero (OK) is returned on success; a negated errno value is return to
|
||||||
|
|||||||
Reference in New Issue
Block a user