osd-contiki/cpu/pic32/lib/pic32_clock.h
2012-12-17 09:14:23 +01:00

75 lines
2.7 KiB
C

/*
* Contiki PIC32 Port project
*
* Copyright (c) 2012,
* Scuola Superiore Sant'Anna (http://www.sssup.it) and
* Consorzio Nazionale Interuniversitario per le Telecomunicazioni
* (http://www.cnit.it).
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the Institute nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
/**
* \addtogroup pic32 PIC32 Contiki Port
*
* @{
*/
/**
* \file pic32_clock.h
* \brief CLOCK interface for PIC32MX (pic32mx795f512l)
* \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
* \date 2012-04-11
*/
#ifndef __INCLUDE_PIC32_CLOCK_H__
#define __INCLUDE_PIC32_CLOCK_H__
#include <stdint.h>
/*
* PIC32MX795F512L - Specific Functions
*
* All the functions in this part of the file are specific for the
* pic32mx795f512l that is characterized by registers' name that differ from
* the 3xx and 4xx families of the pic32mx.
*/
/* Function used to calculate the system clock */
uint32_t pic32_clock_get_system_clock(void);
/* Function used to calculate the peripherals clock */
uint32_t pic32_clock_get_peripheral_clock(void);
/* Function used to calculate the appropriate brg param to approximate desidered frequency */
uint32_t pic32_clock_calculate_brg(uint32_t mul, uint32_t desired);
#endif /* __INCLUDE_PIC32_CLOCK_H__ */
/** @} */