diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index a015584d263..06e62cb2354 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -240,7 +240,7 @@

NuttX RTOS Porting Guide

-

Last Updated: April 2, 2020

+

Last Updated: April 7, 2020

@@ -2948,6 +2948,10 @@ wd_start() on a given watchdog ID has any effect.
  • wdentry. Function to call on timeout
  • argc. The number of uint32_t parameters to pass to wdentry.
  • .... uint32_t size parameters to pass to wdentry + +

    +NOTE: All parameters must be of type wdparm_t. +

    diff --git a/include/nuttx/wdog.h b/include/nuttx/wdog.h index b736ef09c52..d222c4da932 100644 --- a/include/nuttx/wdog.h +++ b/include/nuttx/wdog.h @@ -1,36 +1,20 @@ /**************************************************************************** * include/nuttx/wdog.h * - * Copyright (C) 2007-2009, 2014-2015, 2018 Gregory Nutt. All rights - * reserved. - * Author: Gregory Nutt + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * 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 - * modification, are permitted provided that the following conditions - * are met: + * http://www.apache.org/licenses/LICENSE-2.0 * - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * 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. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. * ****************************************************************************/ @@ -229,10 +213,12 @@ int wd_delete(WDOG_ID wdog); * on a given watchdog ID has any effect. * * Input Parameters: - * wdog - watchdog ID + * wdog - Watchdog ID * delay - Delay count in clock ticks - * wdentry - function to call on timeout - * parm1..4 - parameters to pass to wdentry + * wdentry - Function to call on timeout + * parm1..4 - Parameters to pass to wdentry. + * + * NOTE: All parameters must be of type wdparm_t. * * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to diff --git a/sched/wdog/wd_start.c b/sched/wdog/wd_start.c index 29f7a4b7953..cf9cb27cede 100644 --- a/sched/wdog/wd_start.c +++ b/sched/wdog/wd_start.c @@ -151,10 +151,12 @@ static inline void wd_expiration(void) * on a given watchdog ID has any effect. * * Input Parameters: - * wdog - watchdog ID + * wdog - Watchdog ID * delay - Delay count in clock ticks - * wdentry - function to call on timeout - * parm1..4 - parameters to pass to wdentry + * wdentry - Function to call on timeout + * parm1..4 - Parameters to pass to wdentry + * + * NOTE: All parameters must be of type wdparm_t. * * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to