ST / X_NUCLEO_IDB0XA1

BLE_API wrapper library for STMicroelectronics' BlueNRG Bluetooth Low Energy expansion board shield (Component)

Dependents:   Nucleo_Zumo_BLE_IDB04A1 contest_IOT5 contest_IOT6 contest_IOT_10 ... more

Fork of X_NUCLEO_IDB0XA1 by ST Expansion SW Team

Arduino Connector Compatibility Warning

X-NUCLEO-IDB04A1 and X-NUCLEO-IDB05A1 are Arduino compatible with an exception: instead of using pin D13 for the SPI clock, they use pin D3. The default configuration for this library is having the SPI clock on pin D3.

To be fully Arduino compatible, X-NUCLEO-IDB04A1 and X-NUCLEO-IDB05A1 need a small HW patch.

For X-NUCLEO-IDB04A1 this patch consists in removing zero resistor R10 and instead soldering zero resistor R11. For X-NUCLEO-IDB05A1 this patch consists in removing zero resistor R4 and instead soldering zero resistor R6.

In case you patch your board, then you also have to configure this library to use pin D13 to drive the SPI clock (see macro IDB0XA1_D13_PATCH in file x_nucleo_idb0xa1_targets.h).

If you use pin D13 for the SPI clock, please be aware that on STM32 Nucleo boards you may not drive the LED, otherwise you will get a conflict: the LED on STM32 Nucleo boards is connected to pin D13.

Referring to the current list of tested platforms (see X-NUCLEO-IDB04A1 and X-NUCLEO-IDB05A1 pages), the patch is required by ST-Nucleo-F103RB; ST-Nucleo-F302R8; ST-Nucleo-F411RE; and ST-Nucleo-F446RE.

x-nucleo-idb0xa1/bluenrg-hci/ble_gp_timer.h@307:fa98703ece8e, 2016-09-16 (annotated)

Committer:
Andrea Palmieri
Date:
Fri Sep 16 12:03:25 2016 +0200
Revision:
307:fa98703ece8e
Parent:
290:d8faff21b01f 
Sync with 21bfd161ace255bb6214d6b74cae1fd30b3e24c9



2016-09-16 11:53:47+02:00: Andrea Palmieri

Get rid of warnings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 132:51056160fa4a 1 /******************** (C) COPYRIGHT 2012 STMicroelectronics ********************
Wolfgang Betz 132:51056160fa4a 2 * File Name : gp_timer.h
Wolfgang Betz 132:51056160fa4a 3 * Author : AMS - HEA&RF BU
Wolfgang Betz 132:51056160fa4a 4 * Version : V1.0.0
Wolfgang Betz 132:51056160fa4a 5 * Date : 19-July-2012
Wolfgang Betz 132:51056160fa4a 6 * Description : General purpose timer library.
Wolfgang Betz 132:51056160fa4a 7 ********************************************************************************
Wolfgang Betz 132:51056160fa4a 8 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
Wolfgang Betz 132:51056160fa4a 9 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
Wolfgang Betz 132:51056160fa4a 10 * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
Wolfgang Betz 132:51056160fa4a 11 * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
Wolfgang Betz 132:51056160fa4a 12 * CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
Wolfgang Betz 132:51056160fa4a 13 * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
Wolfgang Betz 132:51056160fa4a 14 *******************************************************************************/
Wolfgang Betz 132:51056160fa4a 15
Wolfgang Betz 132:51056160fa4a 16 #ifndef __GP_TIMER_H__
Wolfgang Betz 132:51056160fa4a 17 #define __GP_TIMER_H__
Wolfgang Betz 132:51056160fa4a 18
Vincent Coubard 290:d8faff21b01f 19 #include "ble_clock.h"
Wolfgang Betz 132:51056160fa4a 20 #include "ble_status.h"
Wolfgang Betz 132:51056160fa4a 21 #ifdef __DMA_LP__
Wolfgang Betz 132:51056160fa4a 22 #include "stm32xx_timerserver.h"
Wolfgang Betz 132:51056160fa4a 23 #endif /* __DMA_LP__ */
Wolfgang Betz 132:51056160fa4a 24
Wolfgang Betz 132:51056160fa4a 25 /**
Wolfgang Betz 132:51056160fa4a 26 * timer
Wolfgang Betz 132:51056160fa4a 27 *
Wolfgang Betz 132:51056160fa4a 28 * A structure that represents a timer. Use Timer_Set() to set the timer.
Wolfgang Betz 132:51056160fa4a 29 *
Wolfgang Betz 132:51056160fa4a 30 */
Wolfgang Betz 132:51056160fa4a 31 struct timer {
Wolfgang Betz 132:51056160fa4a 32
Wolfgang Betz 132:51056160fa4a 33 #ifndef DOXYGEN_SHOULD_SKIP_THIS
Wolfgang Betz 132:51056160fa4a 34
Wolfgang Betz 132:51056160fa4a 35 tClockTime start;
Wolfgang Betz 132:51056160fa4a 36 tClockTime interval;
Wolfgang Betz 132:51056160fa4a 37
Wolfgang Betz 132:51056160fa4a 38 #endif
Wolfgang Betz 132:51056160fa4a 39 };
Wolfgang Betz 132:51056160fa4a 40
Wolfgang Betz 132:51056160fa4a 41 typedef void (* TIMER_HCI_TIMEOUT_NOTIFY_CALLBACK_TYPE)(void);
Wolfgang Betz 132:51056160fa4a 42
Wolfgang Betz 132:51056160fa4a 43 /**
Wolfgang Betz 132:51056160fa4a 44 * Timer_Set
Wolfgang Betz 132:51056160fa4a 45 *
Wolfgang Betz 132:51056160fa4a 46 * @param[in] t Pointer to a timer structure
Wolfgang Betz 132:51056160fa4a 47 * @param[in] interval timeout value
Wolfgang Betz 132:51056160fa4a 48 *
Wolfgang Betz 132:51056160fa4a 49 * This function sets the timeout value of a timer.
Wolfgang Betz 132:51056160fa4a 50 *
Wolfgang Betz 132:51056160fa4a 51 */
Wolfgang Betz 132:51056160fa4a 52 void Timer_Set(struct timer *t, tClockTime interval);
Wolfgang Betz 132:51056160fa4a 53
Wolfgang Betz 132:51056160fa4a 54 /**
Wolfgang Betz 132:51056160fa4a 55 * Timer_Reset
Wolfgang Betz 132:51056160fa4a 56 *
Wolfgang Betz 132:51056160fa4a 57 * @param[in] t Pointer to a timer structure
Wolfgang Betz 132:51056160fa4a 58 *
Wolfgang Betz 132:51056160fa4a 59 * This function resets the timer with the same interval given
Wolfgang Betz 132:51056160fa4a 60 * with Timer_Set, starting from the time it previously expired.
Wolfgang Betz 132:51056160fa4a 61 *
Wolfgang Betz 132:51056160fa4a 62 */
Wolfgang Betz 132:51056160fa4a 63 void Timer_Reset(struct timer *t);
Wolfgang Betz 132:51056160fa4a 64
Wolfgang Betz 132:51056160fa4a 65 /**
Wolfgang Betz 132:51056160fa4a 66 * Timer_Restart
Wolfgang Betz 132:51056160fa4a 67 *
Wolfgang Betz 132:51056160fa4a 68 * @param[in] t Pointer to a timer structure
Wolfgang Betz 132:51056160fa4a 69 *
Wolfgang Betz 132:51056160fa4a 70 * This function resets the timer with the same interval given
Wolfgang Betz 132:51056160fa4a 71 * with Timer_Set, starting from the current time.
Wolfgang Betz 132:51056160fa4a 72 *
Wolfgang Betz 132:51056160fa4a 73 */
Wolfgang Betz 132:51056160fa4a 74 void Timer_Restart(struct timer *t);
Wolfgang Betz 132:51056160fa4a 75
Wolfgang Betz 132:51056160fa4a 76 /**
Wolfgang Betz 132:51056160fa4a 77 * Timer_Expired
Wolfgang Betz 132:51056160fa4a 78 *
Wolfgang Betz 132:51056160fa4a 79 * @param[in] t Pointer to a timer structure
Wolfgang Betz 132:51056160fa4a 80 *
Wolfgang Betz 132:51056160fa4a 81 * This function returns TRUE if timer is expired, FALSE otherwise.
Wolfgang Betz 132:51056160fa4a 82 *
Wolfgang Betz 132:51056160fa4a 83 */
Wolfgang Betz 132:51056160fa4a 84 int Timer_Expired(struct timer *t);
Wolfgang Betz 132:51056160fa4a 85
Wolfgang Betz 132:51056160fa4a 86 /**
Wolfgang Betz 132:51056160fa4a 87 * Timer_Expired
Wolfgang Betz 132:51056160fa4a 88 *
Wolfgang Betz 132:51056160fa4a 89 * @param[in] t Pointer to a timer structure
Wolfgang Betz 132:51056160fa4a 90 *
Wolfgang Betz 132:51056160fa4a 91 * This function returns the time needed for expiration.
Wolfgang Betz 132:51056160fa4a 92 *
Wolfgang Betz 132:51056160fa4a 93 * @return Time before timer's expiration.
Wolfgang Betz 132:51056160fa4a 94 */
Wolfgang Betz 132:51056160fa4a 95 tClockTime Timer_Remaining(struct timer *t);
Wolfgang Betz 132:51056160fa4a 96
Wolfgang Betz 132:51056160fa4a 97 #ifdef __DMA_LP__
Wolfgang Betz 132:51056160fa4a 98 tBleStatus Blue_NRG_HCI_Timer_Start(uint32_t expiryTime,
Wolfgang Betz 132:51056160fa4a 99 TIMER_HCI_TIMEOUT_NOTIFY_CALLBACK_TYPE timercb,
Wolfgang Betz 132:51056160fa4a 100 uint8_t *timerID);
Wolfgang Betz 132:51056160fa4a 101
Wolfgang Betz 132:51056160fa4a 102 tBleStatus Blue_NRG_HCI_Timer_Stop(uint8_t timerID);
Wolfgang Betz 132:51056160fa4a 103 #endif /* __DMA_LP__ */
Wolfgang Betz 132:51056160fa4a 104
Vincent Coubard 290:d8faff21b01f 105 #endif /* __GP_TIMER_H__ */