Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbedtls/mbedtls/timing.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbedAustin 11:cada08fc8a70 1 /**
mbedAustin 11:cada08fc8a70 2 * \file timing.h
mbedAustin 11:cada08fc8a70 3 *
mbedAustin 11:cada08fc8a70 4 * \brief Portable interface to the CPU cycle counter
mbedAustin 11:cada08fc8a70 5 *
mbedAustin 11:cada08fc8a70 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
mbedAustin 11:cada08fc8a70 7 * SPDX-License-Identifier: Apache-2.0
mbedAustin 11:cada08fc8a70 8 *
mbedAustin 11:cada08fc8a70 9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
mbedAustin 11:cada08fc8a70 10 * not use this file except in compliance with the License.
mbedAustin 11:cada08fc8a70 11 * You may obtain a copy of the License at
mbedAustin 11:cada08fc8a70 12 *
mbedAustin 11:cada08fc8a70 13 * http://www.apache.org/licenses/LICENSE-2.0
mbedAustin 11:cada08fc8a70 14 *
mbedAustin 11:cada08fc8a70 15 * Unless required by applicable law or agreed to in writing, software
mbedAustin 11:cada08fc8a70 16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
mbedAustin 11:cada08fc8a70 17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbedAustin 11:cada08fc8a70 18 * See the License for the specific language governing permissions and
mbedAustin 11:cada08fc8a70 19 * limitations under the License.
mbedAustin 11:cada08fc8a70 20 *
mbedAustin 11:cada08fc8a70 21 * This file is part of mbed TLS (https://tls.mbed.org)
mbedAustin 11:cada08fc8a70 22 */
mbedAustin 11:cada08fc8a70 23 #ifndef MBEDTLS_TIMING_H
mbedAustin 11:cada08fc8a70 24 #define MBEDTLS_TIMING_H
mbedAustin 11:cada08fc8a70 25
mbedAustin 11:cada08fc8a70 26 #if !defined(MBEDTLS_CONFIG_FILE)
mbedAustin 11:cada08fc8a70 27 #include "config.h"
mbedAustin 11:cada08fc8a70 28 #else
mbedAustin 11:cada08fc8a70 29 #include MBEDTLS_CONFIG_FILE
mbedAustin 11:cada08fc8a70 30 #endif
mbedAustin 11:cada08fc8a70 31
mbedAustin 11:cada08fc8a70 32 #if !defined(MBEDTLS_TIMING_ALT)
mbedAustin 11:cada08fc8a70 33 // Regular implementation
mbedAustin 11:cada08fc8a70 34 //
mbedAustin 11:cada08fc8a70 35
mbedAustin 11:cada08fc8a70 36 #include <stdint.h>
mbedAustin 11:cada08fc8a70 37
mbedAustin 11:cada08fc8a70 38 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 39 extern "C" {
mbedAustin 11:cada08fc8a70 40 #endif
mbedAustin 11:cada08fc8a70 41
mbedAustin 11:cada08fc8a70 42 /**
mbedAustin 11:cada08fc8a70 43 * \brief timer structure
mbedAustin 11:cada08fc8a70 44 */
mbedAustin 11:cada08fc8a70 45 struct mbedtls_timing_hr_time
mbedAustin 11:cada08fc8a70 46 {
mbedAustin 11:cada08fc8a70 47 unsigned char opaque[32];
mbedAustin 11:cada08fc8a70 48 };
mbedAustin 11:cada08fc8a70 49
mbedAustin 11:cada08fc8a70 50 /**
mbedAustin 11:cada08fc8a70 51 * \brief Context for mbedtls_timing_set/get_delay()
mbedAustin 11:cada08fc8a70 52 */
mbedAustin 11:cada08fc8a70 53 typedef struct
mbedAustin 11:cada08fc8a70 54 {
mbedAustin 11:cada08fc8a70 55 struct mbedtls_timing_hr_time timer;
mbedAustin 11:cada08fc8a70 56 uint32_t int_ms;
mbedAustin 11:cada08fc8a70 57 uint32_t fin_ms;
mbedAustin 11:cada08fc8a70 58 } mbedtls_timing_delay_context;
mbedAustin 11:cada08fc8a70 59
mbedAustin 11:cada08fc8a70 60 extern volatile int mbedtls_timing_alarmed;
mbedAustin 11:cada08fc8a70 61
mbedAustin 11:cada08fc8a70 62 /**
mbedAustin 11:cada08fc8a70 63 * \brief Return the CPU cycle counter value
mbedAustin 11:cada08fc8a70 64 *
mbedAustin 11:cada08fc8a70 65 * \warning This is only a best effort! Do not rely on this!
mbedAustin 11:cada08fc8a70 66 * In particular, it is known to be unreliable on virtual
mbedAustin 11:cada08fc8a70 67 * machines.
mbedAustin 11:cada08fc8a70 68 */
mbedAustin 11:cada08fc8a70 69 unsigned long mbedtls_timing_hardclock( void );
mbedAustin 11:cada08fc8a70 70
mbedAustin 11:cada08fc8a70 71 /**
mbedAustin 11:cada08fc8a70 72 * \brief Return the elapsed time in milliseconds
mbedAustin 11:cada08fc8a70 73 *
mbedAustin 11:cada08fc8a70 74 * \param val points to a timer structure
mbedAustin 11:cada08fc8a70 75 * \param reset if set to 1, the timer is restarted
mbedAustin 11:cada08fc8a70 76 */
mbedAustin 11:cada08fc8a70 77 unsigned long mbedtls_timing_get_timer( struct mbedtls_timing_hr_time *val, int reset );
mbedAustin 11:cada08fc8a70 78
mbedAustin 11:cada08fc8a70 79 /**
mbedAustin 11:cada08fc8a70 80 * \brief Setup an alarm clock
mbedAustin 11:cada08fc8a70 81 *
mbedAustin 11:cada08fc8a70 82 * \param seconds delay before the "mbedtls_timing_alarmed" flag is set
mbedAustin 11:cada08fc8a70 83 *
mbedAustin 11:cada08fc8a70 84 * \warning Only one alarm at a time is supported. In a threaded
mbedAustin 11:cada08fc8a70 85 * context, this means one for the whole process, not one per
mbedAustin 11:cada08fc8a70 86 * thread.
mbedAustin 11:cada08fc8a70 87 */
mbedAustin 11:cada08fc8a70 88 void mbedtls_set_alarm( int seconds );
mbedAustin 11:cada08fc8a70 89
mbedAustin 11:cada08fc8a70 90 /**
mbedAustin 11:cada08fc8a70 91 * \brief Set a pair of delays to watch
mbedAustin 11:cada08fc8a70 92 * (See \c mbedtls_timing_get_delay().)
mbedAustin 11:cada08fc8a70 93 *
mbedAustin 11:cada08fc8a70 94 * \param data Pointer to timing data
mbedAustin 11:cada08fc8a70 95 * Must point to a valid \c mbedtls_timing_delay_context struct.
mbedAustin 11:cada08fc8a70 96 * \param int_ms First (intermediate) delay in milliseconds.
mbedAustin 11:cada08fc8a70 97 * \param fin_ms Second (final) delay in milliseconds.
mbedAustin 11:cada08fc8a70 98 * Pass 0 to cancel the current delay.
mbedAustin 11:cada08fc8a70 99 */
mbedAustin 11:cada08fc8a70 100 void mbedtls_timing_set_delay( void *data, uint32_t int_ms, uint32_t fin_ms );
mbedAustin 11:cada08fc8a70 101
mbedAustin 11:cada08fc8a70 102 /**
mbedAustin 11:cada08fc8a70 103 * \brief Get the status of delays
mbedAustin 11:cada08fc8a70 104 * (Memory helper: number of delays passed.)
mbedAustin 11:cada08fc8a70 105 *
mbedAustin 11:cada08fc8a70 106 * \param data Pointer to timing data
mbedAustin 11:cada08fc8a70 107 * Must point to a valid \c mbedtls_timing_delay_context struct.
mbedAustin 11:cada08fc8a70 108 *
mbedAustin 11:cada08fc8a70 109 * \return -1 if cancelled (fin_ms = 0)
mbedAustin 11:cada08fc8a70 110 * 0 if none of the delays are passed,
mbedAustin 11:cada08fc8a70 111 * 1 if only the intermediate delay is passed,
mbedAustin 11:cada08fc8a70 112 * 2 if the final delay is passed.
mbedAustin 11:cada08fc8a70 113 */
mbedAustin 11:cada08fc8a70 114 int mbedtls_timing_get_delay( void *data );
mbedAustin 11:cada08fc8a70 115
mbedAustin 11:cada08fc8a70 116 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 117 }
mbedAustin 11:cada08fc8a70 118 #endif
mbedAustin 11:cada08fc8a70 119
mbedAustin 11:cada08fc8a70 120 #else /* MBEDTLS_TIMING_ALT */
mbedAustin 11:cada08fc8a70 121 #include "timing_alt.h"
mbedAustin 11:cada08fc8a70 122 #endif /* MBEDTLS_TIMING_ALT */
mbedAustin 11:cada08fc8a70 123
mbedAustin 11:cada08fc8a70 124 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 125 extern "C" {
mbedAustin 11:cada08fc8a70 126 #endif
mbedAustin 11:cada08fc8a70 127
mbedAustin 11:cada08fc8a70 128 #if defined(MBEDTLS_SELF_TEST)
mbedAustin 11:cada08fc8a70 129 /**
mbedAustin 11:cada08fc8a70 130 * \brief Checkup routine
mbedAustin 11:cada08fc8a70 131 *
mbedAustin 11:cada08fc8a70 132 * \return 0 if successful, or 1 if a test failed
mbedAustin 11:cada08fc8a70 133 */
mbedAustin 11:cada08fc8a70 134 int mbedtls_timing_self_test( int verbose );
mbedAustin 11:cada08fc8a70 135 #endif
mbedAustin 11:cada08fc8a70 136
mbedAustin 11:cada08fc8a70 137 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 138 }
mbedAustin 11:cada08fc8a70 139 #endif
mbedAustin 11:cada08fc8a70 140
mbedAustin 11:cada08fc8a70 141 #endif /* timing.h */