blob: e577c5a6fa6c5d17a8b5cdfe693f86f64dae1e5c [file] [log] [blame]
Christina Quast637ace92014-11-28 13:28:37 +01001/* ----------------------------------------------------------------------------
2 * ATMEL Microcontroller Software Support
3 * ----------------------------------------------------------------------------
4 * Copyright (c) 2009, Atmel Corporation
5 *
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the disclaimer below.
13 *
14 * Atmel's name may not be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
20 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
23 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 * ----------------------------------------------------------------------------
28 */
29
30/**
31 * \file
32 *
33 * \section Purpose
34 *
35 * Interface for configuring and using Timer Counter (TC) peripherals.
36 *
37 * \section Usage
38 * -# Optionally, use TC_FindMckDivisor() to let the program find the best
39 * TCCLKS field value automatically.
40 * -# Configure a Timer Counter in the desired mode using TC_Configure().
41 * -# Start or stop the timer clock using TC_Start() and TC_Stop().
42 */
43
44#ifndef _TC_
45#define _TC_
46
47/*------------------------------------------------------------------------------
48 * Headers
49 *------------------------------------------------------------------------------*/
50
51#include "chip.h"
52
53#include <stdint.h>
54
55/*------------------------------------------------------------------------------
56 * Global functions
57 *------------------------------------------------------------------------------*/
58
59#ifdef __cplusplus
60 extern "C" {
61#endif
62
63extern void TC_Configure( Tc *pTc, uint32_t dwChannel, uint32_t dwMode ) ;
64
65extern void TC_Start( Tc *pTc, uint32_t dwChannel ) ;
66
67extern void TC_Stop( Tc *pTc, uint32_t dwChannel ) ;
68
69extern uint32_t TC_FindMckDivisor( uint32_t dwFreq, uint32_t dwMCk, uint32_t *dwDiv, uint32_t *dwTcClks, uint32_t dwBoardMCK ) ;
70
71#ifdef __cplusplus
72}
73#endif
74
75#endif /* #ifndef _TC_ */
76