SAMV71 Xplained Ultra Software Package 1.4

tc.h

Go to the documentation of this file.
00001 /* ----------------------------------------------------------------------------
00002  *         SAM Software Package License
00003  * ----------------------------------------------------------------------------
00004  * Copyright (c) 2011, Atmel Corporation
00005  *
00006  * All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *
00011  * - Redistributions of source code must retain the above copyright notice,
00012  * this list of conditions and the disclaimer below.
00013  *
00014  * Atmel's name may not be used to endorse or promote products derived from
00015  * this software without specific prior written permission.
00016  *
00017  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
00020  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00022  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00023  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00024  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00025  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00026  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  * ----------------------------------------------------------------------------
00028  */
00029 
00030 /**
00031  *  \file
00032  *
00033  *  \section Purpose
00034  *
00035  *  Interface for configuring and using Timer Counter (TC) peripherals.
00036  *
00037  *  \section Usage
00038  *  -# Optionally, use TC_FindMckDivisor() to let the program find the best
00039  *     TCCLKS field value automatically.
00040  *  -# Configure a Timer Counter in the desired mode using TC_Configure().
00041  *  -# Start or stop the timer clock using TC_Start() and TC_Stop().
00042  */
00043 
00044 #ifndef _TC_
00045 #define _TC_
00046 
00047 /*------------------------------------------------------------------------------
00048  *         Headers
00049  *----------------------------------------------------------------------------*/
00050 
00051 #include "chip.h"
00052 
00053 #include <stdint.h>
00054 
00055 /*------------------------------------------------------------------------------
00056  *         Global functions
00057  *----------------------------------------------------------------------------*/
00058 
00059 #ifdef __cplusplus
00060  extern "C" {
00061 #endif
00062 
00063 extern void TC_Configure( Tc *pTc, uint32_t dwChannel, uint32_t dwMode ) ;
00064 
00065 extern void TC_Start( Tc *pTc, uint32_t dwChannel ) ;
00066 
00067 extern void TC_Stop( Tc *pTc, uint32_t dwChannel ) ;
00068 
00069 extern uint32_t TC_FindMckDivisor( uint32_t dwFreq, uint32_t dwMCk, 
00070         uint32_t *dwDiv, uint32_t *dwTcClks, uint32_t dwBoardMCK ) ;
00071 
00072 #ifdef __cplusplus
00073 }
00074 #endif
00075 
00076 #endif /* #ifndef _TC_ */
00077 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines