wangchdo commented on code in PR #17489: URL: https://github.com/apache/nuttx/pull/17489#discussion_r2616352118
########## include/nuttx/hrtimer.h: ########## @@ -0,0 +1,170 @@ +/**************************************************************************** + * include/nuttx/hrtimer.h + * + * SPDX-License-Identifier: Apache-2.0 + * + * 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 + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + ****************************************************************************/ + +#ifndef __INCLUDE_NUTTX_HRTIMER_H +#define __INCLUDE_NUTTX_HRTIMER_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> +#include <nuttx/clock.h> +#include <nuttx/compiler.h> +#include <nuttx/spinlock.h> + +#include <stdint.h> +#include <sys/tree.h> + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +/* Default increment for high-resolution timers if no specific value is set */ + +#define HRTIMER_DEFAULT_INCREMENT ((uint64_t)UINT32_MAX >> 2) + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +/* High-resolution timer modes: + * + * HRTIMER_MODE_ABS - Absolute expiration time + * HRTIMER_MODE_REL - Relative timeout from current time + */ + +enum hrtimer_mode +{ + HRTIMER_MODE_ABS = 0x0, /* Absolute expiration time */ + HRTIMER_MODE_REL = 0x1 /* Relative delay from now */ +}; + +/* Forward declarations */ + +struct hrtimer_s; +struct hrtimer_node_s; +typedef struct hrtimer_s hrtimer_t; +typedef struct hrtimer_node_s hrtimer_node_t; + +/* Callback type for high-resolution timer expiration */ + +typedef void (*hrtentry_t)(FAR struct hrtimer_s *); + +/* Red-black tree node for hrtimer */ + +struct hrtimer_node_s +{ + RB_ENTRY(hrtimer_node_s) entry; /* RB-tree linkage for sorted insertion */ +}; + +/* Red-black tree head for managing active hrtimers */ + +RB_HEAD(hrtimer_tree_s, hrtimer_node_s); + +/* High-resolution timer instance */ + +struct hrtimer_s +{ + struct hrtimer_node_s node; /* RB-tree node for sorted insertion */ + hrtentry_t func; /* Expiration callback function */ + FAR void *arg; /* Argument passed to callback */ + uint64_t expired; /* Expiration time in absolute ns */ +}; + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +#ifdef __cplusplus +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern +#endif + +/**************************************************************************** + * Name: hrtimer_init + * + * Description: + * Initialize a high-resolution timer instance. Sets the expiration + * callback and its argument. The timer is not started by this function. + * + * Input Parameters: + * hrtimer - Pointer to hrtimer instance + * func - Expiration callback function + * arg - Callback argument + * + * Returned Value: + * None + ****************************************************************************/ + +static inline void hrtimer_init(FAR hrtimer_t *hrtimer, Review Comment: Done ########## include/nuttx/hrtimer.h: ########## @@ -0,0 +1,170 @@ +/**************************************************************************** + * include/nuttx/hrtimer.h + * + * SPDX-License-Identifier: Apache-2.0 + * + * 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 + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + ****************************************************************************/ + +#ifndef __INCLUDE_NUTTX_HRTIMER_H +#define __INCLUDE_NUTTX_HRTIMER_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> +#include <nuttx/clock.h> +#include <nuttx/compiler.h> +#include <nuttx/spinlock.h> + +#include <stdint.h> +#include <sys/tree.h> + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +/* Default increment for high-resolution timers if no specific value is set */ + +#define HRTIMER_DEFAULT_INCREMENT ((uint64_t)UINT32_MAX >> 2) + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +/* High-resolution timer modes: + * + * HRTIMER_MODE_ABS - Absolute expiration time + * HRTIMER_MODE_REL - Relative timeout from current time + */ + +enum hrtimer_mode +{ + HRTIMER_MODE_ABS = 0x0, /* Absolute expiration time */ + HRTIMER_MODE_REL = 0x1 /* Relative delay from now */ +}; + +/* Forward declarations */ + +struct hrtimer_s; +struct hrtimer_node_s; +typedef struct hrtimer_s hrtimer_t; +typedef struct hrtimer_node_s hrtimer_node_t; + +/* Callback type for high-resolution timer expiration */ + +typedef void (*hrtentry_t)(FAR struct hrtimer_s *); + +/* Red-black tree node for hrtimer */ + +struct hrtimer_node_s +{ + RB_ENTRY(hrtimer_node_s) entry; /* RB-tree linkage for sorted insertion */ +}; + +/* Red-black tree head for managing active hrtimers */ + +RB_HEAD(hrtimer_tree_s, hrtimer_node_s); + +/* High-resolution timer instance */ + +struct hrtimer_s +{ + struct hrtimer_node_s node; /* RB-tree node for sorted insertion */ + hrtentry_t func; /* Expiration callback function */ + FAR void *arg; /* Argument passed to callback */ + uint64_t expired; /* Expiration time in absolute ns */ +}; + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +#ifdef __cplusplus +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern +#endif + +/**************************************************************************** + * Name: hrtimer_init + * + * Description: + * Initialize a high-resolution timer instance. Sets the expiration + * callback and its argument. The timer is not started by this function. + * + * Input Parameters: + * hrtimer - Pointer to hrtimer instance + * func - Expiration callback function + * arg - Callback argument + * + * Returned Value: + * None + ****************************************************************************/ + +static inline void hrtimer_init(FAR hrtimer_t *hrtimer, + hrtentry_t func, + FAR void *arg) +{ + hrtimer->func = func; Review Comment: Done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
