/*
 * ssp_drv.h
 * Description:
 * See below.
 *
 *

  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) 2008-2014 Intel Corporation.

  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
  2200 Mission College Blvd.
  Santa Clara, CA  97052

  BSD LICENSE 

  Copyright(c) 2008-2014 Intel Corporation. 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.
*/

/*******************************************************************************
 * FILE PURPOSE:    SSP Module Device Driver Header.
 *******************************************************************************
 * FILE NAME:       ssp_drv.h
 *
 * DESCRIPTION:     OS abstracted and platform independent SSP module Header
 *
 * REVISION HISTORY:
 * 19 Mar 03 - Creation - PSP TII  
 *
 ******************************************************************************/

#ifndef __SSP_DRV_H__
#define __SSP_DRV_H__ 

/*The following definitions needed for including ssp_hal.h, shared between vxworks and linux*/
#ifndef INT32
#define INT32 long
#endif

#ifndef UINT8
#define UINT8 unsigned char
#endif

#ifndef UINT16
#define UINT16 unsigned short
#endif

#ifndef UINT32
#define UINT32 unsigned long
#endif

#ifndef BOOL
#define BOOL UINT8
#endif


#include "ssp_hal.h"

/**
 * \defgroup SspDrvReturnCodes SSP Driver Return Codes
 * 
 * SSP Driver Return Codes
 */
/*@{*/

/** \def SSP_DRV_OK SSP Driver API Success */
#define SSP_DRV_OK          SSP_HAL_OK

/** \def SSP_DRV_ERROR SSP Driver API Failure */
#define SSP_DRV_ERROR       SSP_HAL_ERROR

/*@}*/

/**
 *  \brief Device Descriptor returned by the driver
 *
 *  The device descriptor is returned by the driver on completion of
 *  a successful open call. The application should preserve this
 *  descriptor and use it for any further operations on the device.
 */
typedef void* SSP_DRV_DESC_T;

#define SSP_DRIVER_MAGIC	   0xD1

/* I2C */
#define I2C_MAX_BUF_SIZE       100

/* IOCTLs*/
#define I2C_SET_ADDR 	        _IOW( SSP_DRIVER_MAGIC, 1, UINT8 ) 

/* LCD Control IOCTLs */
#define LCD_CTRL_CONTRAST_UP    _IO( SSP_DRIVER_MAGIC, 2 ) 
#define LCD_CTRL_CONTRAST_DOWN  _IO( SSP_DRIVER_MAGIC, 3 ) 


int platform_glcd_get_contrast(void);
int platform_glcd_set_contrast(int val);

SSP_HAL_I2C_INFO_T* ssp_i2c_open( void );
int ssp_i2c_close(SSP_HAL_I2C_INFO_T *     id);
int ssp_i2c_read( SSP_HAL_I2C_INFO_T  *info, UINT8    *buffer, UINT32   len);
int ssp_i2c_write( SSP_HAL_I2C_INFO_T  *info, UINT8    *buffer, UINT32   len);
SSP_HAL_LCD_CTRL_INFO_T* ssp_lcd_ctrl_open( void );
int ssp_lcd_ctrl_close(SSP_HAL_LCD_CTRL_INFO_T * info);


#endif /* __SSP_DRV_H__ */