STMicroelectronics library to handle a hardware timer as a frequency divider.

Dependents:   X_NUCLEO_CCA02M1

Fork of ST_FREQUENCY_DIVIDER by ST Expansion SW Team

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers stm_divider_api.h Source File

stm_divider_api.h

Go to the documentation of this file.
00001 /**
00002  ******************************************************************************
00003  * @file    stm_divider_api.h
00004  * @author  AST / Software Platforms and Cloud
00005  * @version V1.0
00006  * @date    November 8th, 2016
00007  * @brief   Utilities header file for the X_NUCLEO_CCA02M1 expansion board.
00008  ******************************************************************************
00009  * @attention
00010  *
00011  * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00012  *
00013  * Redistribution and use in source and binary forms, with or without modification,
00014  * are permitted provided that the following conditions are met:
00015  *   1. Redistributions of source code must retain the above copyright notice,
00016  *      this list of conditions and the following disclaimer.
00017  *   2. Redistributions in binary form must reproduce the above copyright notice,
00018  *      this list of conditions and the following disclaimer in the documentation
00019  *      and/or other materials provided with the distribution.
00020  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021  *      may be used to endorse or promote products derived from this software
00022  *      without specific prior written permission.
00023  *
00024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  ******************************************************************************
00036  */
00037 
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 
00041 #ifndef __DIVIDER_H
00042 #define __DIVIDER_H
00043 
00044 /* Includes ------------------------------------------------------------------*/
00045 
00046 #include <stdio.h>
00047 
00048 #ifdef __cplusplus
00049 extern "C" {
00050 #endif 
00051 
00052 /* Definitions ---------------------------------------------------------------*/
00053 
00054 #define AUDIO_IN_TIMER                                     TIM3
00055 #define AUDIO_IN_TIMER_CLK_ENABLE()                        __TIM3_CLK_ENABLE()  
00056 #define AUDIO_IN_TIMER_CHOUT_AF                            GPIO_AF2_TIM3
00057 #define AUDIO_IN_TIMER_CHOUT_PIN                           GPIO_PIN_5
00058 #define AUDIO_IN_TIMER_CHOUT_GPIO_PORT                     GPIOB
00059 #define AUDIO_IN_TIMER_CHOUT_GPIO_PORT_CLK_ENABLE()        __GPIOB_CLK_ENABLE()  
00060 #define AUDIO_IN_TIMER_CHIN_AF                             GPIO_AF2_TIM3
00061 #define AUDIO_IN_TIMER_CHIN_PIN                            GPIO_PIN_4
00062 #define AUDIO_IN_TIMER_CHIN_GPIO_PORT                      GPIOB
00063 #define AUDIO_IN_TIMER_CHIN_GPIO_PORT_CLK_ENABLE()         __GPIOB_CLK_ENABLE()   
00064 
00065 
00066 /* Functions -----------------------------------------------------------------*/
00067 
00068 uint8_t ST_Timer_Init(void);
00069 uint8_t ST_Timer_Start(void);
00070 
00071 #ifdef __cplusplus
00072 }
00073 #endif
00074 
00075 #endif