Rahul Dahiya / Mbed OS STM32F7 Ethernet

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/hal/us_ticker_api.h@0:fb8047b156bb, 2020-01-15 (annotated)

Committer:
rahul_dahiya
Date:
Wed Jan 15 15:57:15 2020 +0530
Revision:
0:fb8047b156bb
STM32F7 LWIP

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rahul_dahiya 0:fb8047b156bb 1
rahul_dahiya 0:fb8047b156bb 2 /** \addtogroup hal */
rahul_dahiya 0:fb8047b156bb 3 /** @{*/
rahul_dahiya 0:fb8047b156bb 4 /* mbed Microcontroller Library
rahul_dahiya 0:fb8047b156bb 5 * Copyright (c) 2006-2015 ARM Limited
rahul_dahiya 0:fb8047b156bb 6 *
rahul_dahiya 0:fb8047b156bb 7 * Licensed under the Apache License, Version 2.0 (the "License");
rahul_dahiya 0:fb8047b156bb 8 * you may not use this file except in compliance with the License.
rahul_dahiya 0:fb8047b156bb 9 * You may obtain a copy of the License at
rahul_dahiya 0:fb8047b156bb 10 *
rahul_dahiya 0:fb8047b156bb 11 * http://www.apache.org/licenses/LICENSE-2.0
rahul_dahiya 0:fb8047b156bb 12 *
rahul_dahiya 0:fb8047b156bb 13 * Unless required by applicable law or agreed to in writing, software
rahul_dahiya 0:fb8047b156bb 14 * distributed under the License is distributed on an "AS IS" BASIS,
rahul_dahiya 0:fb8047b156bb 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rahul_dahiya 0:fb8047b156bb 16 * See the License for the specific language governing permissions and
rahul_dahiya 0:fb8047b156bb 17 * limitations under the License.
rahul_dahiya 0:fb8047b156bb 18 */
rahul_dahiya 0:fb8047b156bb 19 #ifndef MBED_US_TICKER_API_H
rahul_dahiya 0:fb8047b156bb 20 #define MBED_US_TICKER_API_H
rahul_dahiya 0:fb8047b156bb 21
rahul_dahiya 0:fb8047b156bb 22 #include <stdint.h>
rahul_dahiya 0:fb8047b156bb 23 #include "hal/ticker_api.h"
rahul_dahiya 0:fb8047b156bb 24
rahul_dahiya 0:fb8047b156bb 25 #ifdef __cplusplus
rahul_dahiya 0:fb8047b156bb 26 extern "C" {
rahul_dahiya 0:fb8047b156bb 27 #endif
rahul_dahiya 0:fb8047b156bb 28
rahul_dahiya 0:fb8047b156bb 29 /**
rahul_dahiya 0:fb8047b156bb 30 * \defgroup hal_UsTicker Microseconds Ticker Functions
rahul_dahiya 0:fb8047b156bb 31 * @{
rahul_dahiya 0:fb8047b156bb 32 */
rahul_dahiya 0:fb8047b156bb 33
rahul_dahiya 0:fb8047b156bb 34 typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
rahul_dahiya 0:fb8047b156bb 35
rahul_dahiya 0:fb8047b156bb 36 /** Set ticker IRQ handler
rahul_dahiya 0:fb8047b156bb 37 *
rahul_dahiya 0:fb8047b156bb 38 * @param ticker_irq_handler IRQ handler to be connected
rahul_dahiya 0:fb8047b156bb 39 *
rahul_dahiya 0:fb8047b156bb 40 * @return previous ticker IRQ handler
rahul_dahiya 0:fb8047b156bb 41 *
rahul_dahiya 0:fb8047b156bb 42 * @note by default IRQ handler is set to ticker_irq_handler()
rahul_dahiya 0:fb8047b156bb 43 * @note this function is primarily for testing purposes and it's not required part of HAL implementation
rahul_dahiya 0:fb8047b156bb 44 *
rahul_dahiya 0:fb8047b156bb 45 */
rahul_dahiya 0:fb8047b156bb 46 ticker_irq_handler_type set_us_ticker_irq_handler(ticker_irq_handler_type ticker_irq_handler);
rahul_dahiya 0:fb8047b156bb 47
rahul_dahiya 0:fb8047b156bb 48 /** Get ticker's data
rahul_dahiya 0:fb8047b156bb 49 *
rahul_dahiya 0:fb8047b156bb 50 * @return The low power ticker data
rahul_dahiya 0:fb8047b156bb 51 */
rahul_dahiya 0:fb8047b156bb 52 const ticker_data_t* get_us_ticker_data(void);
rahul_dahiya 0:fb8047b156bb 53
rahul_dahiya 0:fb8047b156bb 54
rahul_dahiya 0:fb8047b156bb 55 /** The wrapper for ticker_irq_handler, to pass us ticker's data
rahul_dahiya 0:fb8047b156bb 56 *
rahul_dahiya 0:fb8047b156bb 57 */
rahul_dahiya 0:fb8047b156bb 58 void us_ticker_irq_handler(void);
rahul_dahiya 0:fb8047b156bb 59
rahul_dahiya 0:fb8047b156bb 60 /* HAL us ticker */
rahul_dahiya 0:fb8047b156bb 61
rahul_dahiya 0:fb8047b156bb 62 /** Initialize the ticker
rahul_dahiya 0:fb8047b156bb 63 *
rahul_dahiya 0:fb8047b156bb 64 */
rahul_dahiya 0:fb8047b156bb 65 void us_ticker_init(void);
rahul_dahiya 0:fb8047b156bb 66
rahul_dahiya 0:fb8047b156bb 67 /** Read the current counter
rahul_dahiya 0:fb8047b156bb 68 *
rahul_dahiya 0:fb8047b156bb 69 * @return The current timer's counter value in microseconds
rahul_dahiya 0:fb8047b156bb 70 */
rahul_dahiya 0:fb8047b156bb 71 uint32_t us_ticker_read(void);
rahul_dahiya 0:fb8047b156bb 72
rahul_dahiya 0:fb8047b156bb 73 /** Set interrupt for specified timestamp
rahul_dahiya 0:fb8047b156bb 74 *
rahul_dahiya 0:fb8047b156bb 75 * @param timestamp The time in microseconds to be set
rahul_dahiya 0:fb8047b156bb 76 */
rahul_dahiya 0:fb8047b156bb 77 void us_ticker_set_interrupt(timestamp_t timestamp);
rahul_dahiya 0:fb8047b156bb 78
rahul_dahiya 0:fb8047b156bb 79 /** Disable us ticker interrupt
rahul_dahiya 0:fb8047b156bb 80 *
rahul_dahiya 0:fb8047b156bb 81 */
rahul_dahiya 0:fb8047b156bb 82 void us_ticker_disable_interrupt(void);
rahul_dahiya 0:fb8047b156bb 83
rahul_dahiya 0:fb8047b156bb 84 /** Clear us ticker interrupt
rahul_dahiya 0:fb8047b156bb 85 *
rahul_dahiya 0:fb8047b156bb 86 */
rahul_dahiya 0:fb8047b156bb 87 void us_ticker_clear_interrupt(void);
rahul_dahiya 0:fb8047b156bb 88
rahul_dahiya 0:fb8047b156bb 89 /** Set pending interrupt that should be fired right away.
rahul_dahiya 0:fb8047b156bb 90 *
rahul_dahiya 0:fb8047b156bb 91 * The ticker should be initialized prior calling this function.
rahul_dahiya 0:fb8047b156bb 92 */
rahul_dahiya 0:fb8047b156bb 93 void us_ticker_fire_interrupt(void);
rahul_dahiya 0:fb8047b156bb 94
rahul_dahiya 0:fb8047b156bb 95 /** Get frequency and counter bits of this ticker.
rahul_dahiya 0:fb8047b156bb 96 *
rahul_dahiya 0:fb8047b156bb 97 */
rahul_dahiya 0:fb8047b156bb 98 const ticker_info_t* us_ticker_get_info(void);
rahul_dahiya 0:fb8047b156bb 99
rahul_dahiya 0:fb8047b156bb 100 /**@}*/
rahul_dahiya 0:fb8047b156bb 101
rahul_dahiya 0:fb8047b156bb 102 #ifdef __cplusplus
rahul_dahiya 0:fb8047b156bb 103 }
rahul_dahiya 0:fb8047b156bb 104 #endif
rahul_dahiya 0:fb8047b156bb 105
rahul_dahiya 0:fb8047b156bb 106 #endif
rahul_dahiya 0:fb8047b156bb 107
rahul_dahiya 0:fb8047b156bb 108 /** @}*/