617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Use is subject to license terms.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Part of Intel(R) Manageability Engine Interface Linux driver
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Copyright (c) 2003 - 2008 Intel Corp.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * All rights reserved.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Redistribution and use in source and binary forms, with or without
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * modification, are permitted provided that the following conditions
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * are met:
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * 1. Redistributions of source code must retain the above copyright
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * notice, this list of conditions, and the following disclaimer,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * without modification.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * 2. Redistributions in binary form must reproduce at minimum a disclaimer
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * substantially similar to the "NO WARRANTY" disclaimer below
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * ("Disclaimer") and any redistribution must be conditioned upon
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * including a substantially similar Disclaimer requirement for further
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * binary redistribution.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * 3. Neither the names of the above-listed copyright holders nor the names
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * of any contributors may be used to endorse or promote products derived
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * from this software without specific prior written permission.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Alternatively, this software may be distributed under the terms of the
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * GNU General Public License ("GPL") version 2 as published by the Free
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * Software Foundation.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * NO WARRANTY
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * POSSIBILITY OF SUCH DAMAGES.
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan *
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#ifndef _HECI_H_
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define _HECI_H_
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganextern const struct guid heci_pthi_guid;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganextern const struct guid heci_wd_guid;
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganextern const uint8_t start_wd_params[];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganextern const uint8_t stop_wd_params[];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganextern const uint8_t heci_wd_state_independence_msg[3][4];
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * heci device ID
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_82946GZ 0x2974 /* 82946GZ/GL */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_82G35 0x2984 /* 82G35 Express */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_82Q965 0x2994 /* 82Q963/Q965 */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_82G965 0x29A4 /* 82P965/G965 */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_82GM965 0x2A04 /* Mobile PM965/GM965 */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_82GME965 0x2A14 /* Mobile GME965/GLE960 */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_82Q35 0x29B4 /* 82Q35 Express */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_82G33 0x29C4 /* 82G33/G31/P35/P31 Express */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_82Q33 0x29D4 /* 82Q33 Express */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_82X38 0x29E4 /* 82X38/X48 Express */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_3200 0x29F4 /* 3200/3210 Server */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_6 0x28B4 /* Bearlake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_7 0x28C4 /* Bearlake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_8 0x28D4 /* Bearlake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_9 0x28E4 /* Bearlake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9_10 0x28F4 /* Bearlake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9M_1 0x2A44 /* Cantiga */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9M_2 0x2A54 /* Cantiga */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9M_3 0x2A64 /* Cantiga */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH9M_4 0x2A74 /* Cantiga */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH10_1 0x2E04 /* Eaglelake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH10_2 0x2E14 /* Eaglelake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH10_3 0x2E24 /* Eaglelake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#define HECI_DEV_ID_ICH10_4 0x2E34 /* Eaglelake */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * heci init function prototypes
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid init_heci_device(dev_info_t *dip,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct iamt_heci_device *device);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid fini_heci_device(struct iamt_heci_device *device);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_reset(struct iamt_heci_device *dev, int interrupts);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_hw_init(struct iamt_heci_device *dev);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_task_initialize_clients(void *data);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_initialize_clients(struct iamt_heci_device *dev);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_file_private *heci_alloc_file_private(struct heci_file *file);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_disconnect_host_client(struct iamt_heci_device *dev,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file_private *file_ext);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_initialize_list(struct io_heci_list *list,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct iamt_heci_device *dev);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_flush_list(struct io_heci_list *list,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file_private *file_ext);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_flush_queues(struct iamt_heci_device *dev,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file_private *file_ext);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_remove_client_from_file_list(struct iamt_heci_device *dev,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan uint8_t host_client_id);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * interrupt function prototype
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganuint_t heci_isr_interrupt(caddr_t);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_wd_timer(void *data);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan/*
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan * input output function prototype
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan */
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_ioctl_get_version(struct iamt_heci_device *device, int if_num,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_message_data *u_msg, struct heci_message_data k_msg,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file_private *file_ext,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan int mode);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_ioctl_connect_client(struct iamt_heci_device *dev, int if_num,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_message_data *u_msg, struct heci_message_data k_msg,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file *file, int mode);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_ioctl_wd(struct iamt_heci_device *device, int if_num,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_message_data k_msg,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file_private *file_ext, int mode);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_ioctl_bypass_wd(struct iamt_heci_device *device, int if_num,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_message_data k_msg,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file_private *file_ext, int mode);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint heci_start_read(struct iamt_heci_device *device, int if_num,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file_private *file_ext);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint pthi_write(struct iamt_heci_device *device,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_cb_private *priv_cb);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganint pthi_read(struct iamt_heci_device *device, int if_num,
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct heci_file *file, struct uio *uio_p);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganstruct heci_cb_private *find_pthi_read_list_entry(
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan struct iamt_heci_device *device, struct heci_file *file);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid run_next_iamthif_cmd(struct iamt_heci_device *device);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_free_cb_private(struct heci_cb_private *priv_cb);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Loganvoid heci_free_file_private(struct heci_file_private *priv);
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan
617e2443dfc17fe44fd44c0675d6aad2ffc9df42Mark Logan#endif /* _HECI_H_ */