rtc.h

PIXIL is a small footprint operating environment, complete with PDA PIM applications, a browser and

/*                                                                       
 * Copyright (c) 2003 Century Software, Inc.   All Rights Reserved.     
 *                                                                       
 * This file is part of the PIXIL Operating Environment                 
 *                                                                       
 * The use, copying and distribution of this file is governed by one    
 * of two licenses, the PIXIL Commercial License, or the GNU General    
 * Public License, version 2.                                           
 *                                                                       
 * Licensees holding a valid PIXIL Commercial License may use this file 
 * in accordance with the PIXIL Commercial License Agreement provided   
 * with the Software. Others are governed under the terms of the GNU   
 * General Public License version 2.                                    
 *                                                                       
 * This file may be distributed and/or modified under the terms of the  
 * GNU General Public License version 2 as published by the Free        
 * Software Foundation and appearing in the file LICENSE.GPL included   
 * in the packaging of this file.                                      
 *                                                                       
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING  
 * THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A            
 * PARTICULAR PURPOSE.                                                  
 *                                                                       
 * RESTRICTED RIGHTS LEGEND                                             
 *                                                                     
 * Use, duplication, or disclosure by the government is subject to      
 * restriction as set forth in paragraph (b)(3)(b) of the Rights in     
 * Technical Data and Computer Software clause in DAR 7-104.9(a).       
 *                                                                      
 * See http://www.pixil.org/gpl/ for GPL licensing       
 * information.                                                         
 *                                                                      
 * See http://www.pixil.org/license.html or              
 * email [e-mail] for information about the PIXIL   
 * Commercial License Agreement, or if any conditions of this licensing 
 * are not clear to you.                                                
 */

/*
 * Generic RTC interface.
 * This version contains the part of the user interface to the Real Time Clock
 * service. It is used with both the legacy mc146818 and also  EFI
 * Struct rtc_time and first 12 ioctl by Paul Gortmaker, 1996 - separated out
 * from <linux/mc146818rtc.h> to this file for 2.4 kernels.
 * 
 * Copyright (C) 1999 Hewlett-Packard Co.
 * Copyright (C) 1999 Stephane Eranian <[e-mail]>
 */
#ifndef _LINUX_RTC_H_
#define _LINUX_RTC_H_

/*
 * The struct used to pass data via the following ioctl. Similar to the
 * struct tm in <time.h>, but it needs to be here so that the kernel 
 * source is self contained, allowing cross-compiles, etc. etc.
 */

struct rtc_time
{
    int tm_sec;
    int tm_min;
    int tm_hour;
    int tm_mday;
    int tm_mon;
    int tm_year;
    int tm_wday;
    int tm_yday;
    int tm_isdst;
};

/*
 * This data structure is inspired by the EFI (v0.92) wakeup
 * alarm API.
 */
struct rtc_wkalrm
{
    unsigned char enabled;	/* 0 = alarm disable, 1 = alarm disabled */
    unsigned char pending;	/* 0 = alarm pending, 1 = alarm not pending */
    struct rtc_time time;	/* time the alarm is set to */
};


/*
 * ioctl calls that are permitted to the /dev/rtc interface, if 
 * CONFIG_RTC/CONFIG_EFI_RTC was enabled.
 */

#define RTC_AIE_ON	_IO('p', 0x01)	/* Alarm int. enable on         */
#define RTC_AIE_OFF	_IO('p', 0x02)	/* ... off                      */
#define RTC_UIE_ON	_IO('p', 0x03)	/* Update int. enable on        */
#define RTC_UIE_OFF	_IO('p', 0x04)	/* ... off                      */
#define RTC_PIE_ON	_IO('p', 0x05)	/* Periodic int. enable on      */
#define RTC_PIE_OFF	_IO('p', 0x06)	/* ... off                      */
#define RTC_WIE_ON	_IO('p', 0x0f)	/* Watchdog int. enable on      */
#define RTC_WIE_OFF	_IO('p', 0x10)	/* ... off                      */

#define RTC_ALM_SET	_IOW('p', 0x07, struct rtc_time)	/* Set alarm time  */
#define RTC_ALM_READ	_IOR('p', 0x08, struct rtc_time)	/* Read alarm time */
#define RTC_RD_TIME	_IOR('p', 0x09, struct rtc_time)	/* Read RTC time   */
#define RTC_SET_TIME	_IOW('p', 0x0a, struct rtc_time)	/* Set RTC time    */
#define RTC_IRQP_READ	_IOR('p', 0x0b, unsigned long)	/* Read IRQ rate   */
#define RTC_IRQP_SET	_IOW('p', 0x0c, unsigned long)	/* Set IRQ rate    */
#define RTC_EPOCH_READ	_IOR('p', 0x0d, unsigned long)	/* Read epoch      */
#define RTC_EPOCH_SET	_IOW('p', 0x0e, unsigned long)	/* Set epoch       */

#define RTC_WKALM_SET	_IOW('p', 0x0f, struct rtc_wkalrm)	/* Set wakeup alarm */
#define RTC_WKALM_RD	_IOR('p', 0x10, struct rtc_wkalrm)	/* Get wakeup alarm */

#endif /* _LINUX_RTC_H_ */