r_riic_sys.h 4.14 KB
/*
****************************************************************************
PROJECT : RIIC driver
FILE ID : $Id: r_riic_sys.h 11013 2016-11-08 09:07:54Z florian.zimmermann $
============================================================================ 
DESCRIPTION
Driver for RIIC macro
============================================================================
                            C O P Y R I G H T                            
============================================================================
                           Copyright (c) 2014
                                  by 
                       Renesas Electronics (Europe) GmbH. 
                           Arcadiastrasse 10
                          D-40472 Duesseldorf
                               Germany
                          All rights reserved.
============================================================================
Purpose: only for testing

DISCLAIMER                                                                   
This software is supplied by Renesas Electronics Corporation and is only     
intended for use with Renesas products. No other uses are authorized. This   
software is owned by Renesas Electronics Corporation and is protected under  
all applicable laws, including copyright laws.                               
THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING  
THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT      
LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE   
AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.          
TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS       
ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE  
FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR   
ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE  
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.                             
Renesas reserves the right, without notice, to make changes to this software 
and to discontinue the availability of this software. By using this software,
you agree to the additional terms and conditions found by accessing the      
following link:                                                              
http://www.renesas.com/disclaimer *                                          
Copyright (C) 2011 Renesas Electronics Corporation. All rights reserved.     

****************************************************************************

*/

#ifndef R_RIIC_SYS_H_
#define R_RIIC_SYS_H_

#ifdef __cplusplus
extern "C" {
#endif

/*******************************************************************************
  Title: RIIC Support Functions

  The generic RIIC driver uses these functions. They have
  to be implemented within the driver library for a concrete
  device.
*/

/*******************************************************************************
  Section: Global Functions
*/

/*******************************************************************************
  Function: R_SYS_RIIC_BaseAddr

  Gives back base address of dedicated macro channel.
  
  Parameters:
  Unit       - Instance number
  
  Returns:
  Macro base address
*/

uint32_t R_SYS_RIIC_BaseAddr(uint32_t Unit);


/*******************************************************************************
  Function: R_SYS_RIIC_SysGetClockHz

  Gives back clock frequency for the selected instance. 
  
  Parameters:
  Unit      - Instance number
  
  Returns:
  Clock frequency
*/

uint32_t R_SYS_RIIC_SysGetClockHz(uint32_t Unit);


/*******************************************************************************
  Function: R_SYS_RIIC_Init

  Initialize the given Unit on device level 
  
  Parameters:
  Unit       - Instance number
  
  Returns:
  void
*/

void R_SYS_RIIC_Init(uint32_t Unit);


/*******************************************************************************
  Function: R_SYS_RIIC_DeInit

  De-Initialize the given Unit on device level 
  
  Parameters:
  Unit       - Instance number
  
  Returns:
  void
*/

void R_SYS_RIIC_DeInit(uint32_t Unit);


#ifdef __cplusplus
}
#endif


#endif /* R_RIIC_SYS_H_ */