/*
 * This file is provided under a dual BSD/GPLv2 license.  When using or 
 *   redistributing this file, you may do so under either license.
 * 
 *   GPL LICENSE SUMMARY
 * 
 *   Copyright(c) 2007,2008 Intel Corporation. All rights reserved.
 * 
 *   This program is free software; you can redistribute it and/or modify 
 *   it under the terms of version 2 of the GNU General Public License as
 *   published by the Free Software Foundation.
 * 
 *   This program is distributed in the hope that it will be useful, but 
 *   WITHOUT ANY WARRANTY; without even the implied warranty of 
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
 *   General Public License for more details.
 * 
 *   You should have received a copy of the GNU General Public License 
 *   along with this program; if not, write to the Free Software 
 *   Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *   The full GNU General Public License is included in this distribution 
 *   in the file called LICENSE.GPL.
 * 
 *   Contact Information:
 *   Intel Corporation
 * 
 *   BSD LICENSE 
 * 
 *   Copyright(c) 2007,2008 Intel Corporation. All rights reserved.
 *   All rights reserved.
 * 
 *   Redistribution and use in source and binary forms, with or without 
 *   modification, are permitted provided that the following conditions 
 *   are met:
 * 
 *     * Redistributions of source code must retain the above copyright 
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in 
 *       the documentation and/or other materials provided with the 
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its 
 *       contributors may be used to endorse or promote products derived 
 *       from this software without specific prior written permission.
 * 
 *   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 MERCHANTABILITY AND FITNESS FOR 
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *   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 DAMAGE.
 * 
 * 
 *  version: Embedded.L.0.7.187
 */
/* 
* NetApp change history @ 21-Dec-2011 (under CONFIG_NETAPP_HWDD):
*  - renamed driver locally to hwdd_gpio.c 
*  - var "DRIVERNAME" changed to "hwdd_gpio", from "gpio_ref"
*  - LPC_DEVICE_ID changed to 0x2918(from 0x5031) w.r.t ICH9 spec for Carnegie, 
*        -- This should be changed(value awaited) w.r.t PCH Spec accordingly for BBA
*  - Enhancement this driver needs, should the GPIO signals goes beyond 64 
*		(-- now itself count is 76 - referred recent PCM doc dated 20-Dec-2011)
*		--	Need to add offsets for SEL3 and LVL3 as per PCH doc:
*			--- Offset 40h: GPIO_USE_SEL3
*			--- Offset 44h: GP_IO_SEL3
*			--- Offset 48h: GP_LVL3
*			--- Offset 60h: GP_RST_SEL
* 		--	Max gpio signals from 64 to 128 and thereby increase memory size for same from 64B to 128B
*		--	LPC device spec(Bus/Dev/Fn.) on PCI bus w.r.t. PCH spec. (eg: LPC_DEVICE_ID)
*		--	any other change to incorporate above comments or other!
*/
/*****************************************************************************
 * Module name:
 *    gpio
 *
 * Abstract:
 *    This header file is to be included by the gpio.c file only. 
 *
 * Revision:
 *    TBD
 *
 *****************************************************************************/

#ifndef GPIO_H
#define GPIO_H

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/socket.h>
#include <linux/poll.h>   
#include <linux/init.h>
#include <linux/fs.h>       
#include <linux/errno.h>    
#include <linux/types.h>    
#include <linux/proc_fs.h>
#include <linux/fcntl.h>    
#include <linux/interrupt.h>
#include <asm/system.h>     
#include <asm/uaccess.h>
#include <linux/pci.h>
#include <linux/cdev.h>


#include "linux_ioctls.h"
#include "common.h"

#ifdef CONFIG_NETAPP_HWDD 
#define DRIVERNAME "hwdd_gpio"
#else 
#define DRIVERNAME "gpio_ref"
#endif 

/******************************************************************************
 
  Description:
     This structure contains data that is used for most driver operations.
 
 *****************************************************************************/
typedef struct drvr_data
{
	gpio_regs_t regs;
	dev_t devnum;
	struct cdev cdev;
	void *mem_virt;
	unsigned int mem_base;
	unsigned int mem_resrvd;
} drvr_data_t;

//drvr_data_t g_drvr_data;

// Linux system calls
int gpio_init(void);
void gpio_close(void);
int gpio_open(struct inode *inode, struct file *filp);
int gpio_release(struct inode *inode, struct file *filp);
int gpio_ioctl(struct inode *inode, struct file *filp, unsigned int cmd, 
			   unsigned long arg);

// private driver functions
int gpio_getpininfo(int Signal, char *pBuff);
void set_reg_addrs(unsigned int addr);

// Linux file operations
struct file_operations file_ops = 
{
	.owner	=	THIS_MODULE,
	.open   =    gpio_open,
	.release =   gpio_release,	
	.ioctl	=	gpio_ioctl,
};

#endif