[deliverable/linux.git] / include / acpi / achware.h

/******************************************************************************
 *
 * Name: achware.h -- hardware specific interfaces
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2008, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACHWARE_H__
#define __ACHWARE_H__

/* PM Timer ticks per second (HZ) */

#define PM_TIMER_FREQUENCY  3579545

/* Values for the _SST reserved method */

#define ACPI_SST_INDICATOR_OFF  0
#define ACPI_SST_WORKING        1
#define ACPI_SST_WAKING         2
#define ACPI_SST_SLEEPING       3
#define ACPI_SST_SLEEP_CONTEXT  4

/* Prototypes */

/*
 * hwacpi - high level functions
 */
acpi_status acpi_hw_set_mode(u32 mode);

u32 acpi_hw_get_mode(void);

/*
 * hwregs - ACPI Register I/O
 */
struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id);

acpi_status
acpi_hw_register_read(u32 register_id, u32 * return_value);

acpi_status acpi_hw_register_write(u32 register_id, u32 value);

acpi_status acpi_hw_clear_acpi_status(void);

/*
 * hwgpe - GPE support
 */
acpi_status acpi_hw_low_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);

acpi_status
acpi_hw_write_gpe_enable_reg(struct acpi_gpe_event_info *gpe_event_info);

acpi_status
acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
			  struct acpi_gpe_block_info *gpe_block, void *context);

acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info);

acpi_status
acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
			struct acpi_gpe_block_info *gpe_block, void *context);

acpi_status
acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
		       acpi_event_status * event_status);

acpi_status acpi_hw_disable_all_gpes(void);

acpi_status acpi_hw_enable_all_runtime_gpes(void);

acpi_status acpi_hw_enable_all_wakeup_gpes(void);

acpi_status
acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
				 struct acpi_gpe_block_info *gpe_block,
				 void *context);

#ifdef	ACPI_FUTURE_USAGE
/*
 * hwtimer - ACPI Timer prototypes
 */
acpi_status acpi_get_timer_resolution(u32 * resolution);

acpi_status acpi_get_timer(u32 * ticks);

acpi_status
acpi_get_timer_duration(u32 start_ticks, u32 end_ticks, u32 * time_elapsed);
#endif				/* ACPI_FUTURE_USAGE */

#endif				/* __ACHWARE_H__ */
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: achware.h -- hardware specific interfaces
	4	*
	5	*****************************************************************************/
	6
	7	/*
75a44ce0	8	* Copyright (C) 2000 - 2008, Intel Corp.
1da177e4 LT	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	14	* 1. Redistributions of source code must retain the above copyright
	15	* notice, this list of conditions, and the following disclaimer,
	16	* without modification.
	17	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	18	* substantially similar to the "NO WARRANTY" disclaimer below
	19	* ("Disclaimer") and any redistribution must be conditioned upon
	20	* including a substantially similar Disclaimer requirement for further
	21	* binary redistribution.
	22	* 3. Neither the names of the above-listed copyright holders nor the names
	23	* of any contributors may be used to endorse or promote products derived
	24	* from this software without specific prior written permission.
	25	*
	26	* Alternatively, this software may be distributed under the terms of the
	27	* GNU General Public License ("GPL") version 2 as published by the Free
	28	* Software Foundation.
	29	*
	30	* NO WARRANTY
	31	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	32	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	33	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	34	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	35	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	36	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	37	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	38	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	39	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	40	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	41	* POSSIBILITY OF SUCH DAMAGES.
	42	*/
	43
	44	#ifndef __ACHWARE_H__
	45	#define __ACHWARE_H__
	46
1da177e4	47	/* PM Timer ticks per second (HZ) */
44f6c012	48
1da177e4 LT	49	#define PM_TIMER_FREQUENCY 3579545
1da177e4 LT	50
44f6c012	51	/* Values for the _SST reserved method */
1da177e4	52
44f6c012 RM	53	#define ACPI_SST_INDICATOR_OFF 0
	54	#define ACPI_SST_WORKING 1
	55	#define ACPI_SST_WAKING 2
	56	#define ACPI_SST_SLEEPING 3
	57	#define ACPI_SST_SLEEP_CONTEXT 4
1da177e4	58
44f6c012	59	/* Prototypes */
1da177e4	60
44f6c012 RM	61	/*
	62	* hwacpi - high level functions
	63	*/
4be44fcd	64	acpi_status acpi_hw_set_mode(u32 mode);
1da177e4	65
4be44fcd	66	u32 acpi_hw_get_mode(void);
1da177e4	67
44f6c012 RM	68	/*
	69	* hwregs - ACPI Register I/O
	70	*/
4be44fcd	71	struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id);
1da177e4 LT	72
1da177e4 LT	73	acpi_status
d30dc9ab	74	acpi_hw_register_read(u32 register_id, u32 * return_value);
1da177e4	75
d30dc9ab	76	acpi_status acpi_hw_register_write(u32 register_id, u32 value);
1da177e4	77
d8c71b6d	78	acpi_status acpi_hw_clear_acpi_status(void);
1da177e4	79
44f6c012 RM	80	/*
	81	* hwgpe - GPE support
	82	*/
e38e8a07 BM	83	acpi_status acpi_hw_low_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
e38e8a07 BM	84
1da177e4	85	acpi_status
4be44fcd	86	acpi_hw_write_gpe_enable_reg(struct acpi_gpe_event_info *gpe_event_info);
1da177e4 LT	87
1da177e4 LT	88	acpi_status
4be44fcd	89	acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
e97d6bf1	90	struct acpi_gpe_block_info gpe_block, void context);
1da177e4	91
4be44fcd	92	acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info);
1da177e4 LT	93
1da177e4 LT	94	acpi_status
4be44fcd	95	acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
e97d6bf1	96	struct acpi_gpe_block_info gpe_block, void context);
1da177e4	97
1da177e4	98	acpi_status
4be44fcd LB	99	acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
4be44fcd LB	100	acpi_event_status * event_status);
1da177e4	101
4be44fcd	102	acpi_status acpi_hw_disable_all_gpes(void);
1da177e4	103
4be44fcd	104	acpi_status acpi_hw_enable_all_runtime_gpes(void);
1da177e4	105
4be44fcd	106	acpi_status acpi_hw_enable_all_wakeup_gpes(void);
1da177e4 LT	107
1da177e4 LT	108	acpi_status
4be44fcd	109	acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
e97d6bf1 BM	110	struct acpi_gpe_block_info *gpe_block,
e97d6bf1 BM	111	void *context);
1da177e4	112
44f6c012 RM	113	#ifdef ACPI_FUTURE_USAGE
	114	/*
	115	* hwtimer - ACPI Timer prototypes
	116	*/
4be44fcd	117	acpi_status acpi_get_timer_resolution(u32 * resolution);
1da177e4	118
4be44fcd	119	acpi_status acpi_get_timer(u32 * ticks);
1da177e4 LT	120
1da177e4 LT	121	acpi_status
4be44fcd LB	122	acpi_get_timer_duration(u32 start_ticks, u32 end_ticks, u32 * time_elapsed);
4be44fcd LB	123	#endif /* ACPI_FUTURE_USAGE */
1da177e4	124
4be44fcd	125	#endif /* __ACHWARE_H__ */