rtc_api.h

MIPS下的boottloader yamon 的源代码

/************************************************************************
 *
 *      RTC_api.h
 *
 *      The 'RTC' module implements a device driver 
 *      for MC146818A/DS1685/DS1687 compatible RTCs.
 *
 *        1) init  serial device:  configure and initialize RTC driver
 *        2) open  serial device:  not used
 *        3) close serial device:  not used
 *        4) read  serial device:  get RTC
 *        5) write serial device:  set RTC
 *        6) ctrl  serial device:  not used
 *
 *
 * ######################################################################
 *
 * Copyright (c) 1999-2000 MIPS Technologies, Inc. All rights reserved. 
 * 
 * Unpublished rights reserved under the Copyright Laws of the United States of 
 * America. 
 * 
 * This document contains information that is proprietary to MIPS Technologies, 
 * Inc. ("MIPS Technologies"). Any copying, modifying or use of this information 
 * (in whole or in part) which is not expressly permitted in writing by MIPS 
 * Technologies or a contractually-authorized third party is strictly 
 * prohibited. At a minimum, this information is protected under unfair 
 * competition laws and the expression of the information contained herein is 
 * protected under federal copyright laws. Violations thereof may result in 
 * criminal penalties and fines. 
 * MIPS Technologies or any contractually-authorized third party reserves the 
 * right to change the information contained in this document to improve 
 * function, design or otherwise. MIPS Technologies does not assume any 
 * liability arising out of the application or use of this information. Any 
 * license under patent rights or any other intellectual property rights owned 
 * by MIPS Technologies or third parties shall be conveyed by MIPS Technologies 
 * or any contractually-authorized third party in a separate license agreement 
 * between the parties. 
 * The information contained in this document constitutes one or more of the 
 * following: commercial computer software, commercial computer software 
 * documentation or other commercial items. If the user of this information, 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 information, 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 information 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 information from MIPS Technologies or any 
 * contractually-authorized third party. 
 *
 ************************************************************************/

#ifndef RTC_API_H
#define RTC_API_H

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

#include <sysdefs.h>
#include <syserror.h>

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

/************************************************************************
 *   RTC device driver, ERROR completion codes
*************************************************************************/
typedef enum RTC_error_ids
{
    ERROR_RTC_NO_FRAME                  /* No receive frame present     */
		= ERROR_RTC,  
    ERROR_RTC_COMM_ERROR,               /* Communication error detected */

/******* ADD NEW IO ERROR TAGS JUST BEFORE THIS LINE ONLY *******/

} t_RTC_error_ids;


/************************************************************************
 *  Parameter definitions
*************************************************************************/

/* RTC value */
typedef struct RTC_calendar
{
    UINT16  year;
    UINT16  month;
    UINT16  dayofmonth;
    UINT16  dayofweek;
    UINT16  hour;
    UINT16  minute;
    UINT16  second;
} 
t_RTC_calendar;


/************************************************************************
 *  RTC device driver services, called by IO subsystem
*************************************************************************/


/************************************************************************
 *
 *  NAME:  'init'
 *
 *  Description :
 *  -------------
 *  This service initializes the RTC driver.
 *
 *  Return values :
 *  ---------------
 *  'OK' = 0x00
 *
 ************************************************************************/
typedef INT32 (*t_RTC_init_service)( 
          UINT32 major,          /* IN: major device number             */
          UINT32 minor,          /* not used                            */
          void   *p_param ) ;    /* not used                            */


/************************************************************************
 *
 *  NAME:  'read'
 *
 *  Description :
 *  -------------
 *  This service reads the current value of the Real Time Clock.
 *
 *  Return values :
 *  ---------------
 *  'OK' = 0x00              current RTC-value read into user variable
 *
 ************************************************************************/
typedef INT32 (*t_RTC_read_service)( 
          UINT32 major,          /* IN: major device number             */
          UINT32 minor,          /* IN: minor device number             */
          t_RTC_calendar *p_param ) ; /* INOUT: current RTC value       */


/************************************************************************
 *
 *  NAME:  'write'
 *
 *  Description :
 *  -------------
 *  This service sets the current value of the Real Time Clock.
 *
 *  Return values :
 *  ---------------
 *  'OK' = 0x00              RTC value has been set successfully
 *
 ************************************************************************/
typedef INT32 (*t_RTC_write_service)( 
          UINT32 major,          /* IN: major device number             */
          UINT32 minor,          /* IN: minor device number             */
          t_RTC_calendar *p_param ) ; /* OUT: calendar value to set     */


/************************************************************************
 *  Public functions
 ************************************************************************/


/************************************************************************
 *
 *                          RTC_install
 *  Description :
 *  -------------
 *
 *  Installs the RTC device drivers services in the IO system 
 *  at the reserved device slot, found in the 'sys_dev.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 :
 *  ------------
 *
 *  None
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0)
 *  'ERROR_IO_ILLEGAL_MAJOR':  Illegal major device number
 *  'ERROR_IO_NO_SPACE':       Device slot already allocated
 *
 ************************************************************************/
INT32 
RTC_install( void );

#endif /* #ifndef RTC_API_H */