[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / 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__

/* Values for the _SST predefined 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

/*
 * 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_write_pm1_control(u32 pm1a_control, u32 pm1b_control);

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);

/*
 * hwvalid - Port I/O with validation
 */
acpi_status acpi_hw_read_port(acpi_io_address address, u32 *value, u32 width);

acpi_status acpi_hw_write_port(acpi_io_address address, u32 value, u32 width);

/*
 * 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
50df4d8b	47	/* Values for the _SST predefined method */
1da177e4	48
44f6c012 RM	49	#define ACPI_SST_INDICATOR_OFF 0
	50	#define ACPI_SST_WORKING 1
	51	#define ACPI_SST_WAKING 2
	52	#define ACPI_SST_SLEEPING 3
	53	#define ACPI_SST_SLEEP_CONTEXT 4
1da177e4	54
44f6c012 RM	55	/*
	56	* hwacpi - high level functions
	57	*/
4be44fcd	58	acpi_status acpi_hw_set_mode(u32 mode);
1da177e4	59
4be44fcd	60	u32 acpi_hw_get_mode(void);
1da177e4	61
44f6c012 RM	62	/*
	63	* hwregs - ACPI Register I/O
	64	*/
4be44fcd	65	struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id);
1da177e4	66
32c9ef99 BM	67	acpi_status acpi_hw_write_pm1_control(u32 pm1a_control, u32 pm1b_control);
	68
	69	acpi_status acpi_hw_register_read(u32 register_id, u32 *return_value);
1da177e4	70
d30dc9ab	71	acpi_status acpi_hw_register_write(u32 register_id, u32 value);
1da177e4	72
d8c71b6d	73	acpi_status acpi_hw_clear_acpi_status(void);
1da177e4	74
7f071903 BM	75	/*
	76	* hwvalid - Port I/O with validation
	77	*/
	78	acpi_status acpi_hw_read_port(acpi_io_address address, u32 *value, u32 width);
	79
	80	acpi_status acpi_hw_write_port(acpi_io_address address, u32 value, u32 width);
	81
44f6c012 RM	82	/*
	83	* hwgpe - GPE support
	84	*/
e38e8a07 BM	85	acpi_status acpi_hw_low_disable_gpe(struct acpi_gpe_event_info *gpe_event_info);
e38e8a07 BM	86
1da177e4	87	acpi_status
4be44fcd	88	acpi_hw_write_gpe_enable_reg(struct acpi_gpe_event_info *gpe_event_info);
1da177e4 LT	89
1da177e4 LT	90	acpi_status
4be44fcd	91	acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
e97d6bf1	92	struct acpi_gpe_block_info gpe_block, void context);
1da177e4	93
4be44fcd	94	acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info);
1da177e4 LT	95
1da177e4 LT	96	acpi_status
4be44fcd	97	acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
e97d6bf1	98	struct acpi_gpe_block_info gpe_block, void context);
1da177e4	99
1da177e4	100	acpi_status
4be44fcd LB	101	acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
4be44fcd LB	102	acpi_event_status * event_status);
1da177e4	103
4be44fcd	104	acpi_status acpi_hw_disable_all_gpes(void);
1da177e4	105
4be44fcd	106	acpi_status acpi_hw_enable_all_runtime_gpes(void);
1da177e4	107
4be44fcd	108	acpi_status acpi_hw_enable_all_wakeup_gpes(void);
1da177e4 LT	109
1da177e4 LT	110	acpi_status
4be44fcd	111	acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
e97d6bf1 BM	112	struct acpi_gpe_block_info *gpe_block,
e97d6bf1 BM	113	void *context);
1da177e4	114
44f6c012 RM	115	#ifdef ACPI_FUTURE_USAGE
	116	/*
	117	* hwtimer - ACPI Timer prototypes
	118	*/
4be44fcd	119	acpi_status acpi_get_timer_resolution(u32 * resolution);
1da177e4	120
4be44fcd	121	acpi_status acpi_get_timer(u32 * ticks);
1da177e4 LT	122
1da177e4 LT	123	acpi_status
4be44fcd LB	124	acpi_get_timer_duration(u32 start_ticks, u32 end_ticks, u32 * time_elapsed);
4be44fcd LB	125	#endif /* ACPI_FUTURE_USAGE */
1da177e4	126
4be44fcd	127	#endif /* __ACHWARE_H__ */