pkarashchenko commented on a change in pull request #5723: URL: https://github.com/apache/incubator-nuttx/pull/5723#discussion_r825133104
########## File path: arch/xtensa/src/esp32s3/esp32s3_rt_timer.h ########## @@ -0,0 +1,254 @@ +/**************************************************************************** + * arch/xtensa/src/esp32s3/esp32s3_rt_timer.h + * + * 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 __ARCH_XTENSA_SRC_ESP32S3_ESP32S3_RT_TIMER_H +#define __ARCH_XTENSA_SRC_ESP32S3_ESP32S3_RT_TIMER_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <stdint.h> +#include <sys/types.h> + +#include <nuttx/list.h> + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#define RT_TIMER_NOFLAGS (0) /* Timer supports no feature */ +#define RT_TIMER_REPEAT (1 << 0) /* Timer supports repeat mode */ + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +/** + * RT timer state + */ + +enum rt_timer_state_e +{ + RT_TIMER_IDLE, /* Timer is not counting */ + RT_TIMER_READY, /* Timer is counting */ + RT_TIMER_TIMEOUT, /* Timer timed out */ + RT_TIMER_DELETE /* Timer is to be delete */ +}; + +/** + * RT timer data structure + */ + +struct rt_timer_s +{ + uint64_t timeout; /* Timeout value */ + uint64_t alarm; /* Timeout period */ + void (*callback)(void *arg); /* Callback function */ + void *arg; /* Private data */ + uint16_t flags; /* Supported features */ + enum rt_timer_state_e state; /* Timer state */ + struct list_node list; /* Working list */ +}; + +/** + * RT timer creation arguments data structure + */ + +struct rt_timer_args_s +{ + void (*callback)(void *arg); /* Callback function */ + void *arg; /* Private data */ +}; + +#if defined(__cplusplus) +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern +#endif + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +/**************************************************************************** + * Name: esp32s3_rt_timer_create + * + * Description: + * Create an RT Timer from the provided arguments. + * + * Input Parameters: + * args - RT Timer creation arguments. + * + * Output Parameters: + * timer_handle - Pointer to RT Timer handle. + * + * Returned Value: + * Zero (OK) is returned on success. A negated errno value is returned to + * indicate the nature of any failure. + * + ****************************************************************************/ + +int esp32s3_rt_timer_create(const struct rt_timer_args_s *args, + struct rt_timer_s **timer_handle); + +/**************************************************************************** + * Name: esp32s3_rt_timer_start + * + * Description: + * Start the RT Timer. + * + * Input Parameters: + * timer - Pointer to the RT Timer state structure. + * timeout - Timeout value. + * repeat - Repeat mode (true: enabled, false: disabled). + * + * Returned Value: + * None. + * + ****************************************************************************/ + +void esp32s3_rt_timer_start(struct rt_timer_s *timer, + uint64_t timeout, + bool repeat); + +/**************************************************************************** + * Name: esp32s3_rt_timer_stop + * + * Description: + * Stop the RT Timer. + * + * Input Parameters: + * timer - Pointer to the RT Timer state structure. + * + * Returned Value: + * None + * + ****************************************************************************/ + +void esp32s3_rt_timer_stop(struct rt_timer_s *timer); + +/**************************************************************************** + * Name: esp32s3_rt_timer_delete + * + * Description: + * Stop and delete the RT Timer. + * + * Input Parameters: + * timer - Pointer to the RT Timer state structure. + * + * Returned Value: + * None. + * + ****************************************************************************/ + +void esp32s3_rt_timer_delete(struct rt_timer_s *timer); + +/**************************************************************************** + * Name: esp32s3_rt_timer_time_us + * + * Description: + * Get current counter value of the RT Timer in microseconds. + * + * Input Parameters: + * None. + * + * Returned Value: + * Time of the RT Timer in microseconds. + * + ****************************************************************************/ + +uint64_t esp32s3_rt_timer_time_us(void); + +/**************************************************************************** + * Name: esp32s3_rt_timer_get_alarm + * + * Description: + * Get the remaining time to the next timeout. + * + * Input Parameters: + * None. + * + * Returned Value: + * Timestamp of the nearest timer event in microseconds. + * + ****************************************************************************/ + +uint64_t esp32s3_rt_timer_get_alarm(void); + +/**************************************************************************** + * Name: esp32s3_rt_timer_calibration + * + * Description: + * Adjust current RT Timer by a certain value. + * + * Input Parameters: + * time_us - Adjustment to apply to the RT Timer in microseconds. + * + * Returned Value: + * None. + * + ****************************************************************************/ + +void esp32s3_rt_timer_calibration(uint64_t time_us); + +/**************************************************************************** + * Name: esp32s3_rt_timer_init + * + * Description: + * Initialize ESP32-S3 RT Timer. + * + * Input Parameters: + * None. + * + * Returned Value: + * Zero (OK) is returned on success. A negated errno value is returned to + * indicate the nature of any failure. + * + ****************************************************************************/ + +int esp32s3_rt_timer_init(void); + +/**************************************************************************** + * Name: esp32s3_rt_timer_deinit + * + * Description: + * Deinitialize ESP32-S3 RT Timer. + * + * Input Parameters: + * None. + * + * Returned Value: + * None. + * + ****************************************************************************/ + +void esp32s3_rt_timer_deinit(void); + +#ifdef __cplusplus +} +#endif +#undef EXTERN Review comment: ```suggestion ``` ########## File path: arch/xtensa/src/esp32s3/esp32s3_rt_timer.h ########## @@ -0,0 +1,254 @@ +/**************************************************************************** + * arch/xtensa/src/esp32s3/esp32s3_rt_timer.h + * + * 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 __ARCH_XTENSA_SRC_ESP32S3_ESP32S3_RT_TIMER_H +#define __ARCH_XTENSA_SRC_ESP32S3_ESP32S3_RT_TIMER_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <stdint.h> +#include <sys/types.h> + +#include <nuttx/list.h> + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#define RT_TIMER_NOFLAGS (0) /* Timer supports no feature */ +#define RT_TIMER_REPEAT (1 << 0) /* Timer supports repeat mode */ + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +/** + * RT timer state + */ + +enum rt_timer_state_e +{ + RT_TIMER_IDLE, /* Timer is not counting */ + RT_TIMER_READY, /* Timer is counting */ + RT_TIMER_TIMEOUT, /* Timer timed out */ + RT_TIMER_DELETE /* Timer is to be delete */ +}; + +/** + * RT timer data structure + */ + +struct rt_timer_s +{ + uint64_t timeout; /* Timeout value */ + uint64_t alarm; /* Timeout period */ + void (*callback)(void *arg); /* Callback function */ + void *arg; /* Private data */ + uint16_t flags; /* Supported features */ + enum rt_timer_state_e state; /* Timer state */ + struct list_node list; /* Working list */ +}; + +/** + * RT timer creation arguments data structure + */ + +struct rt_timer_args_s +{ + void (*callback)(void *arg); /* Callback function */ + void *arg; /* Private data */ +}; + +#if defined(__cplusplus) +#define EXTERN extern "C" Review comment: ```suggestion ``` ########## File path: arch/xtensa/src/esp32s3/esp32s3_rt_timer.h ########## @@ -0,0 +1,254 @@ +/**************************************************************************** + * arch/xtensa/src/esp32s3/esp32s3_rt_timer.h + * + * 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 __ARCH_XTENSA_SRC_ESP32S3_ESP32S3_RT_TIMER_H +#define __ARCH_XTENSA_SRC_ESP32S3_ESP32S3_RT_TIMER_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <stdint.h> +#include <sys/types.h> + +#include <nuttx/list.h> + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#define RT_TIMER_NOFLAGS (0) /* Timer supports no feature */ +#define RT_TIMER_REPEAT (1 << 0) /* Timer supports repeat mode */ + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +/** + * RT timer state + */ + +enum rt_timer_state_e +{ + RT_TIMER_IDLE, /* Timer is not counting */ + RT_TIMER_READY, /* Timer is counting */ + RT_TIMER_TIMEOUT, /* Timer timed out */ + RT_TIMER_DELETE /* Timer is to be delete */ +}; + +/** + * RT timer data structure + */ + +struct rt_timer_s +{ + uint64_t timeout; /* Timeout value */ + uint64_t alarm; /* Timeout period */ + void (*callback)(void *arg); /* Callback function */ + void *arg; /* Private data */ + uint16_t flags; /* Supported features */ + enum rt_timer_state_e state; /* Timer state */ + struct list_node list; /* Working list */ +}; + +/** + * RT timer creation arguments data structure + */ + +struct rt_timer_args_s +{ + void (*callback)(void *arg); /* Callback function */ + void *arg; /* Private data */ +}; + +#if defined(__cplusplus) +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern Review comment: ```suggestion ``` -- 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: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
