i2c.h

意法半导体ARM7 STR710+DM9000A的TCP/IP实现

/******************** (C) COPYRIGHT 2003 STMicroelectronics ********************
* File Name          : i2c.h
* Author             : MCD Application Team
* Date First Issued  : 05/09/2003
* Description        : This file provides prototypes of I2C functions
*                      and variable used in code sources
********************************************************************************
* History:
*  13/01/2006 : V3.1
*  24/05/2005 : V3.0
*  30/11/2004 : V2.0
*  14/07/2004 : V1.3
*  01/01/2004 : V1.2
*******************************************************************************
 THE PRESENT SOFTWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH
 CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
 AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT
 OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT
 OF SUCH SOFTWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION
 CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
*******************************************************************************/

#ifndef __i2c_H
#define __i2c_H

#include "71x_map.h"

typedef enum
{
  I2C_CR   = 0x00,
  I2C_SR1  = 0x04,
  I2C_SR2  = 0x08,
  I2C_CCR  = 0x0C,
  I2C_OAR1 = 0x10,
  I2C_OAR2 = 0x14,
  I2C_DR   = 0x18,
  I2C_ECCR = 0x1C
} I2C_Registers;

typedef enum
{
  I2C_Mode10,
  I2C_Mode7
} I2C_Addressing;

typedef enum
{
  I2C_RX,
  I2C_TX
} I2C_Direction;

typedef enum
{
  I2C_SB    = 0x00001,
  I2C_M_SL  = 0x00002,
  I2C_ADSL  = 0x00004,
  I2C_BTF   = 0x00008,
  I2C_BUSY  = 0x00010,
  I2C_TRA   = 0x00020,
  I2C_ADD10 = 0x00040,
  I2C_EVF   = 0x00080,
  I2C_GCAL  = 0x00100,
  I2C_BERR  = 0x00200,
  I2C_ARLO  = 0x00400,
  I2C_STOPF = 0x00800,
  I2C_AF    = 0x01000,
  I2C_ENDAD = 0x02000,
  I2C_STOP  = 0x08000,
  I2C_ACK   = 0x10000,
  I2C_START = 0x20000
} I2C_Flags;



typedef enum
{
  I2C_TX_NO,
  I2C_TX_SB,
  I2C_TX_AF,
  I2C_TX_ARLO,
  I2C_TX_BERR,
  I2C_TX_ADD_OK,
  I2C_TX_DATA_OK,
  I2C_TX_ONGOING
} I2C_Tx_Status;

typedef enum
{
  I2C_RX_NO,
  I2C_RX_SB,
  I2C_RX_AF,
  I2C_RX_ARLO,
  I2C_RX_BERR,
  I2C_RX_ADD_OK,
  I2C_RX_DATA_OK,
  I2C_RX_ONGOING
} I2C_Rx_Status;

// #define I2C_PESET_Mask 0x20
// #define I2C_PERESET    0xDF
// #define I2C_ENGC_Mask  0x10
// #define I2C_START_Mask 0x08
// #define I2C_STOP_Mask  0x02
// #define I2C_ACK_Mask   0x04
// #define I2C_ITE_Mask   0x01

/* Exported constants --------------------------------------------------------*/
#define I2C_SB               0x0001
#define I2C_M_SL             0x0002
#define I2C_ADSL             0x0004
#define I2C_BTF              0x0008
#define I2C_BUSY             0x0010
#define I2C_TRA              0x0020
#define I2C_ADD10            0x0040
#define I2C_EVF              0x0080
#define I2C_GCAL             0x0100
#define I2C_BERR             0x0200
#define I2C_ARLO             0x0400
#define I2C_STOPF            0x0800
#define I2C_AF               0x1000
#define I2C_ENDAD            0x2000
#define I2C_STOP             0x8000
#define I2C_ACK              0x10000
#define I2C_START            0x20000

#define I2C_PESET_Mask       0x20
#define I2C_PERESET          0xDF
#define I2C_ENGC_Mask        0x10
#define I2C_START_Mask       0x08
#define I2C_STOP_Mask        0x02
#define I2C_ACK_Mask         0x04
#define I2C_ITE_Mask         0x01
#define I2C_Event_Mask       0x3FFF

/* I2C Events */
#define  I2C_EVENT_SLAVE_ADDRESS_MATCHED   ( I2C_EVF | I2C_BUSY  | I2C_ADSL)    
#define  I2C_EVENT_SLAVE_BYTE_RECEIVED     ( I2C_EVF | I2C_BUSY  | I2C_BTF )     
#define  I2C_EVENT_SLAVE_BYTE_TRANSMITTED  ( I2C_EVF | I2C_BUSY  | I2C_BTF  | I2C_TRA ) 
#define  I2C_EVENT_MASTER_MODE_SELECT      ( I2C_EVF | I2C_BUSY  | I2C_M_SL | I2C_SB )                 
#define  I2C_EVENT_MASTER_MODE_SELECTED    ( I2C_EVF | I2C_BUSY  | I2C_M_SL | I2C_ENDAD )    
#define  I2C_EVENT_MASTER_BYTE_RECEIVED    ( I2C_EVF | I2C_BUSY  | I2C_M_SL | I2C_BTF )                
#define  I2C_EVENT_MASTER_BYTE_TRANSMITTED ( I2C_EVF | I2C_BUSY  | I2C_M_SL | I2C_BTF | I2C_TRA )  
#define  I2C_EVENT_MASTER_MODE_ADDRESS10   ( I2C_EVF | I2C_BUSY  | I2C_M_SL | I2C_ADD10 )               
#define  I2C_EVENT_SLAVE_STOP_DETECTED       I2C_STOPF                                  
#define  I2C_EVENT_SLAVE_ACK_FAILURE       ( I2C_EVF | I2C_BUSY | I2C_BTF  | I2C_TRA | I2C_AF)    

#define  I2C_BUS_ERROR_DETECTED       I2C_BERR
#define  I2C_ARBITRATION_LOST         I2C_ARLO
#define  I2C_SLAVE_GENERAL_CALL       (I2C_BUSY | I2C_GCAL)



/*******************************************************************************
* Function Name  : I2C_Init
* Description    : Initializes I2C peripheral control and registers to their
*                  default reset values.
* Input          : I2Cx ( I2C0 or I2C1 )
* Return         : None.
*******************************************************************************/
void I2C_Init (I2C_TypeDef *I2Cx);

/*******************************************************************************
* Function Name  : I2C_OnOffConfig
* Description    : Enables or disables I2C peripheral.
* Input          : I2Cx ( I2C0 or I2C1 )
*                  condition(ENABLE or DISABLE).
* Return         : None.
*******************************************************************************/
void I2C_OnOffConfig (I2C_TypeDef *I2Cx, FunctionalState NewState);

/*******************************************************************************
* Function Name  : I2C_GeneralCallConfig
* Description    : Enables or disables I2C general call option.
* Input          : I2Cx ( I2C0 or I2C1 )
*                  condition(ENABLE or DISABLE).
* Return         : None.
*******************************************************************************/
inline void I2C_GeneralCallConfig (I2C_TypeDef *I2Cx, FunctionalState NewState)
{
  if (NewState == ENABLE) I2Cx->CR |= I2C_ENGC_Mask;
     else I2Cx->CR &= ~I2C_ENGC_Mask;
}

/*******************************************************************************
* Function Name  : I2C_STARTGenerate
* Description    : Generates I2C communication START condition.
* Input          : I2Cx ( I2C0 or I2C1 )
*                  condition(ENABLE or DISABLE).
* Return         : None.