eeprom_iic.c

MIPS YAMON, a famous monitor inc. source, make file and PDF manuals.

/************************************************************************
 *
 *      EEPROM_IIC.c
 *
 *      The 'EEPROM_IIC' module implements the EEPROM with IIC-bus access 
 *      device driver as an IO device with following services:
 *
 *        1) init  device:  configure and initialize EEPROM driver
 *        2) open  device:  not used
 *        3) close device:  not used
 *        4) read  device:  read EEPROM device
 *        5) write device:  write EEPROM device
 *        6) ctrl  device:  not used
 *
 *
 * ######################################################################
 *
 * mips_start_of_legal_notice
 * 
 * Copyright (c) 2004 MIPS Technologies, Inc. All rights reserved.
 *
 *
 * Unpublished rights (if any) reserved under the copyright laws of the
 * United States of America and other countries.
 *
 * This code is proprietary to MIPS Technologies, Inc. ("MIPS
 * Technologies"). Any copying, reproducing, modifying or use of this code
 * (in whole or in part) that is not expressly permitted in writing by MIPS
 * Technologies or an authorized third party is strictly prohibited. At a
 * minimum, this code is protected under unfair competition and copyright
 * laws. Violations thereof may result in criminal penalties and fines.
 *
 * MIPS Technologies reserves the right to change this code to improve
 * function, design or otherwise. MIPS Technologies does not assume any
 * liability arising out of the application or use of this code, or of any
 * error or omission in such code. Any warranties, whether express,
 * statutory, implied or otherwise, including but not limited to the implied
 * warranties of merchantability or fitness for a particular purpose, are
 * excluded. Except as expressly provided in any written license agreement
 * from MIPS Technologies or an authorized third party, the furnishing of
 * this code does not give recipient any license to any intellectual
 * property rights, including any patent rights, that cover this code.
 *
 * This code shall not be exported, reexported, transferred, or released,
 * directly or indirectly, in violation of the law of any country or
 * international law, regulation, treaty, Executive Order, statute,
 * amendments or supplements thereto. Should a conflict arise regarding the
 * export, reexport, transfer, or release of this code, the laws of the
 * United States of America shall be the governing law.
 *
 * This code constitutes one or more of the following: commercial computer
 * software, commercial computer software documentation or other commercial
 * items. If the user of this code, or any related documentation of any
 * kind, including related technical data or manuals, is an agency,
 * department, or other entity of the United States government
 * ("Government"), the use, duplication, reproduction, release,
 * modification, disclosure, or transfer of this code, or any related
 * documentation of any kind, is restricted in accordance with Federal
 * Acquisition Regulation 12.212 for civilian agencies and Defense Federal
 * Acquisition Regulation Supplement 227.7202 for military agencies. The use
 * of this code by the Government is further restricted in accordance with
 * the terms of the license agreement(s) and/or applicable contract terms
 * and conditions covering this code from MIPS Technologies or an authorized
 * third party.
 *
 *
 *
 * 
 * mips_end_of_legal_notice
 * 
 *
 ************************************************************************/




/************************************************************************
 *      Include files
 ************************************************************************/

#include <sysdefs.h>
#include <syserror.h>
#include <sysdev.h>
#include <string.h>
#include <io_api.h>
#include <syscon_api.h>
#include <iic_api.h>
#include <eeprom_api.h>
#include <eeprom_iic_api.h>

/************************************************************************
 *      Definitions
 ************************************************************************/

/*
    Device context per EEPROM
                                                                        */
typedef struct EEPROM_IIC_device
{
    UINT32  size ;           /* size of EEPROM device                   */
    UINT32  pagesize ;       /* pagesize of EEPROM device               */
    UINT8   iicadr ;         /* IIC-slave base address                  */
    UINT8   mode ;           /* read-only or read-write                 */
} t_EEPROM_IIC_device ;


#define EEPROM_READ_ONLY_MODE    0x42
#define EEPROM_READ_WRITE_MODE   0x43

/************************************************************************
 *      NM24C09 EEPROM profile 
 ************************************************************************/

#define EEPROM_NM24C09_SIZE          1024
#define EEPROM_NM24C09_PAGESIZE      256


/************************************************************************
 *      SPD EEPROM profile of PC-SDRAM
 ************************************************************************/

#define EEPROM_SPD_SIZE              256
#define EEPROM_SPD_PAGESIZE          256


/************************************************************************
 *  Macro Definitions
*************************************************************************/


/************************************************************************
 *      Public variables
 ************************************************************************/



/************************************************************************
 *      Static variables
 ************************************************************************/

/*
  EEPROM device context
*/
static
t_EEPROM_IIC_device device[EEPROM_MINOR_DEVICE_COUNT] ;

/*
  Temporary buffer for read and write operations 
*/
static UINT8  iic_buffer[EEPROM_NM24C09_PAGESIZE+4] ;


/* Error strings */
static char* error_strings[] =
{
    /* ERROR_EEPROM_COMM_ERROR */         "I2C communication error detected",
    /* ERROR_EEPROM_UNKNOWN_DEVICE */     "Unknown device",
    /* ERROR_EEPROM_PARAM_OUT_OF_SPACE */ "Address space out of range",
    /* ERROR_EEPROM_READ_ONLY */          "EEPROM is read-only"
};


/************************************************************************
 *      Static function prototypes
 ************************************************************************/


/************************************************************************
 *
 *                          EEPROM_IIC_init
 *  Description :
 *  -------------
 *  This service initializes the EEPROM IIC driver.
 *  
 *
 *  Parameters :
 *  ------------
 *
 *  'major',     IN,    major device number
 *  'minor',     IN,    not used
 *  'p_param',   INOUT, not used
 *
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0)
 *
 *
 *
 ************************************************************************/
static
INT32 EEPROM_IIC_init(
          UINT32 major,          /* IN: major device number             */
          UINT32 minor,          /* IN: minor device number             */
          void   *p_param ) ;    /* INOUT: device parameter block       */


/************************************************************************
 *
 *                          EEPROM_IIC_read
 *  Description :
 *  -------------
 *  This service reads data from a specified location of a specified
 *  EEPROM device.
 *
 *  Parameters :
 *  ------------
 *
 *  'major',     IN,    major device number
 *  'minor',     IN,    minor device number for multi device drivers
 *  'p_param',   INOUT, variable of type, t_EEPROM_read_descriptor.
 *
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0)
 *
 *
 ************************************************************************/
static
INT32 EEPROM_IIC_read(
          UINT32 major,          /* IN: major device number             */
          UINT32 minor,          /* IN: minor device number             */
          t_EEPROM_read_descriptor *p_param ) ; /* INOUT: read buffer   */


/************************************************************************
 *
 *                          EEPROM_IIC_write
 *  Description :
 *  -------------
 *  This service writes data into a specified location of a specified
 *  EEPROM device.
 *  
 *
 *  Parameters :
 *  ------------
 *
 *  'major',     IN,    major device number
 *  'minor',     IN,    minor device number for multi device drivers
 *  'p_param',   INOUT, variable of type, t_EEPROM_write_descriptor.
 *
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0)
 *
 *
 ************************************************************************/
static
INT32 EEPROM_IIC_write(
          UINT32 major,          /* IN: major device number             */
          UINT32 minor,          /* IN: minor device number             */
          t_EEPROM_write_descriptor *p_param ) ; /* IN: write buffer    */


static INT32 
error_lookup( 
    t_sys_error_string *param );


/************************************************************************
 *      Implementation : Public functions
 ************************************************************************/


/************************************************************************
 *
 *                          EEPROM_IIC_install
 *  Description :
 *  -------------
 *
 *  Installs the EEPROM device driver services in 
 *  the IO system at the reserved device slot, found in the
 *  'sysdev.h' file, which defines all major device numbers.
 *
 *  Note:
 *  This service is the only public declared interface function; all
 *  provided device driver services are static declared, but this
 *  function installs the function pointers in the io-system to
 *  enable the provided public driver services.
 *
 *  Parameters :
 *  ------------
 *
 *  -
 *
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0)
 *  'ERROR_IO_ILLEGAL_MAJOR':  Illegal major device number
 *  'ERROR_IO_NO_SPACE':       Device slot already allocated
 *
 ************************************************************************/