iic_piix4.c

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

/************************************************************************
 *
 *      iic_piix4.c
 *
 *      The 'IIC_PIIX4' module implements the IIC device driver
 *      interface to be used via 'IIC' device driver services:
 *
 *        1) init  serial device:  configure and initialize IIC driver
 *        2) open  serial device:  not used
 *        3) close serial device:  not used
 *        4) read  serial device:  read IIC device
 *        5) write serial device:  write IIC device
 *        6) ctrl  serial device:  a) write+read IIC device
 *                                 b) test IIC device
 *
 *
 * ######################################################################
 *
 * 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 <sys_api.h>
#include <io_api.h>
#include <syserror.h>
#include <syscon_api.h>
#include <sysdev.h>
#include <iic_api.h>
#include <iic_piix4_api.h>
#include <piix4.h>

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

#define SMB_WRITE( offset, data ) \
    REG8( sys_reg_addr( bigend, sizeof(UINT8), base, offset ) ) = data;

#define SMB_READ( offset, p_data ) \
    *p_data = REG8( sys_reg_addr( bigend, sizeof(UINT8), base, offset ) );

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

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

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

static void *base;
static bool bigend;

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

static INT32 
iic_piix4_init(
    UINT32 major,		/* IN: major device number             */
    UINT32 minor,		/* IN: minor device number             */
    void   *param );		/* INOUT: device parameter block       */

static INT32 
iic_piix4_read(
    UINT32 major,		/* IN: major device number             */
    UINT32 minor,		/* IN: minor device number             */
    t_IIC_read_descriptor *param );  /* INOUT: read buffer	       */

static INT32 
iic_piix4_write(
    UINT32 major,		/* IN: major device number             */
    UINT32 minor,		/* IN: minor device number             */
    t_IIC_write_descriptor *param );	     /* IN: write buffer       */

static INT32 
iic_piix4_ctrl(
    UINT32 major,		/* IN: major device number             */
    UINT32 minor,		/* IN: minor device number             */
    t_IIC_ctrl_descriptor *param );	     /* INOUT: IIC device data */

static void 
iic_piix4_poll( void );


/************************************************************************
 *      Implementation : Static functions
 ************************************************************************/


/************************************************************************
 *
 *                          iic_piix4_init
 *  Description :
 *  -------------
 *  This service initializes the IIC driver
 *
 *  Parameters :
 *  ------------
 *
 *  'major',     IN,    major device number
 *  'minor',     IN,    not used
 *  'param',     INOUT, not used
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0) or error code
 *
 ************************************************************************/
static INT32 
iic_piix4_init(
    UINT32 major,		/* IN: major device number             */
    UINT32 minor,		/* IN: minor device number             */
    void   *param )		/* INOUT: device parameter block       */
{
    SYSCON_read( SYSCON_BOARD_PIIX4_SMB_BASE_ID,
		 (void *)&base,
		 sizeof(UINT32) );

    base = (void *)KSEG1( (UINT32)base );

    SYSCON_read( SYSCON_COM_PIIX4_IIC_BIGEND_ID,
		 (void *)&bigend,
		 sizeof(bool) );

    return OK;
}


/************************************************************************
 *
 *                          iic_piix4_read
 *  Description :
 *  -------------
 *  This service reads data from the specified IIC device into the
 *  user allocated variable, *param.
 *
 *  Parameters :
 *  ------------
 *
 *  'major',     IN,    major device number
 *  'minor',     IN,    minor device number for multi device drivers
 *  'param',     INOUT, variable of type, t_IIC_read_descriptor.
 *
 *  Return values :
 *  ---------------
 *
 *  'OK' = 0x00:              IIC device data read into user variable
 *  'ERROR_IIC_COMM_ERROR':   communication error detected
 *
 ************************************************************************/
static INT32 
iic_piix4_read(
    UINT32 major,		/* IN: major device number             */
    UINT32 minor,		/* IN: minor device number             */
    t_IIC_read_descriptor *param )   /* INOUT: read buffer	       */
{
    /* TBD : Not ready */
    return ERROR_IIC_COMM_ERROR;
}


/************************************************************************
 *
 *                          iic_piix4_write
 *  Description :
 *  -------------
 *  This service writes user data to the specified IIC device.
 *
 *  Parameters :
 *  ------------
 *
 *  'major',     IN,    major device number