include/drivers/superio.h

/*
 * Copyright 2012, Google Inc.
 * 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 Google Inc. 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.
 *
 * superio.h: This is intended for generic SuperIO configuration functions.
 * Functions for a specific SuperIO or Embedded Controller (EC) chips should
 * go in a different driver.
 */

#ifndef MOSYS_DRIVERS_SUPERIO_H__
#define MOSYS_DRIVERS_SUPERIO_H__

#include "mosys/platform.h"

/*
 * i8042 "legacy" (ps/2) keyboard controller interface
 * For more information: http://www.computer-engineering.org/ps2keyboard/
 */
#define I8042_DATA	0x60		/* legacy IO data port */
#define I8042_CSR	0x64		/* legacy command/status port */
#define I8042_OBF	(1 << 0)	/* output buffer full */
#define I8042_IBF	(1 << 1)	/* input buffer full */
#define I8042_SYS	(1 << 2)	/* system flag */
#define I8042_A2	(1 << 3)	/* A2 */
#define I8042_INH	(1 << 4)	/* inhibit flag */
#define I8042_MOBF	(1 << 5)	/* mouse output buffer full */
#define I8042_TO	(1 << 6)	/* general timeout */
#define I8042_PERR	(1 << 7)	/* parity error */

/* common superio global config registers */
#define SIO_LDNSEL	0x07
#define SIO_CHIPID1	0x20
#define SIO_CHIPID2	0x21
#define SIO_CHIPVER	0x22
#define SIO_CTL		0x23

/* i8042 host interface (command/status and data port pair) */
struct i8042_host_intf {
	uint16_t csr;	/* command / status port */
	uint16_t data;	/* data port */
};

struct sio_id {
	char *vendor;
	char *name;
	uint8_t num_id_bytes;
	uint8_t chipid[2];
	uint8_t chipver;
};

/*
 * i8042_wait_ibf_clear - wait for input buffer to become empty
 *
 * @intf:	platform interface
 * @i8042_intf:	host interface information (i8042 values will be used if NULL)
 * @timeout_ms:	timeout period in milliseconds
 *
 * returns 1 to indicate input buffer is empty
 * returns 0 to indicate input buffer is not empty within timeout period
 * returns <0 to indicate error
 */
int i8042_wait_ibf_clear(struct platform_intf *intf,
			struct i8042_host_intf *i8042_intf,
			unsigned int timeout_ms);

/*
 * i8042_wait_obf_set - wait for output buffer to become full
 *
 * @intf:	platform interface
 * @i8042_intf:	host interface information (i8042 values will be used if NULL)
 * @timeout_ms:	timeout period in milliseconds
 *
 * returns 1 to indicate output buffer is full
 * returns 0 to indicate output buffer not full within timeout period
 * returns <0 to indicate error
 */
int i8042_wait_obf_set(struct platform_intf *intf,
			struct i8042_host_intf *i8042_intf,
			unsigned int timeout_ms);

/*
 * sio_read - read from SuperIO
 *
 * intf:	platform interface
 * port:	super io port
 * reg:		register offset within current logical device
 *
 * returns logical device number to indicate success
 * returns <0 to indicate failure
 */
extern uint8_t sio_read(struct platform_intf *intf, uint16_t port, uint8_t reg);

/*
 * sio_write - write to SuperIO
 *
 * intf:	platform interface
 * port:	super io port
 * reg:		register offset within current logical device
 * data:	data to write
 *
 * returns <0 to indicate failure
 */
extern void sio_write(struct platform_intf *intf, uint16_t port,
                      uint8_t reg, uint8_t data);

const struct sio_id *get_sio_id(struct platform_intf *intf, uint16_t port);

#endif	/* MOSYS_DRIVERS_SUPERIO_H__ */