platform/experimental/parrot/ec.c

/*
 * 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.
 */

#include <unistd.h>
#include <sys/time.h>

#include "mosys/log.h"
#include "mosys/platform.h"
#include "drivers/ene/kb932.h"
#include "intf/io.h"

#include "parrot.h"


/**
 * Parrot EC firmware specific constants
 */
static const uint16_t parrot_ec_port = 0xfd60;

static const uint16_t parrot_ec_cmd        = 0x6c;
static const uint16_t parrot_ec_data       = 0x68;
static const uint8_t ec_input_buffer_full  = 2;
static const uint8_t ec_output_buffer_full = 1;
static const uint8_t ec_command_timeout    = 4;
static const uint8_t cmd_fw_version        = 0x51;

/**
 * Wait for EC firmware input buffer empty
 *
 * @param intf          platform_intf
 * @return 0            success
 * @return -1           timeout
 */
static int ec_wait_input(struct platform_intf *intf)
{
	struct timeval begin, now;
	uint8_t ec_state;

	gettimeofday(&begin, NULL);
	do {
		io_read8(intf, parrot_ec_cmd, &ec_state);

		if (!(ec_state & ec_input_buffer_full))
			return 0;

		gettimeofday(&now, NULL);
	} while (now.tv_sec - begin.tv_sec < ec_command_timeout);

	return -1;
}

/**
 * Wait for EC firmware output buffer empty
 *
 * @param intf          platform_intf
 * @return 0            success
 * @return -1           timeout
 */
static int ec_wait_output(struct platform_intf *intf)
{
	struct timeval begin, now;
	uint8_t ec_state;

	gettimeofday(&begin, NULL);
	do {
		io_read8(intf, parrot_ec_cmd, &ec_state);

		if (ec_state & ec_output_buffer_full)
			return 0;

		gettimeofday(&now, NULL);
	} while (now.tv_sec - begin.tv_sec < ec_command_timeout);

	return -1;
}

/* Write command to ec firmware command port */
static int ec_cmd(struct platform_intf *intf, uint8_t cmd)
{
	if (ec_wait_input(intf))
		return -1;

	io_write8(intf, parrot_ec_cmd, cmd);
	return 0;
}

/* Read data from ec firmware data port */
static int ec_read(struct platform_intf *intf, uint16_t port, uint8_t *data)
{
	if (ec_wait_output(intf))
		return -1;

	io_read8(intf, port, data);
	return 0;
}


static const char *parrot_ec_vendor(struct platform_intf *intf)
{
	return ene_kb932_detect(intf, parrot_ec_port) ?
		"ENE" : "Unknown";
}

static const char *parrot_ec_name(struct platform_intf *intf)
{
	return ene_kb932_detect(intf, parrot_ec_port) ?
		"KB932" : "Unknown";
}

static void bcd_to_ascii(uint8_t bcd, char *ascii)
{
	uint8_t digit;

	/* high nibble first */
	digit = bcd >> 4;
	if (digit <= 9)
		ascii[0] = digit + '0';

	digit = bcd & 0xf;
	if (digit <= 9)
		ascii[1] = digit + '0';
}

/**
 * Get parrot vendor specific fw version string
 *
 * Parrot ec firmware version format: '00BEmnnArr'
 *   '00BE' - hardware type, parrot
 *   'mnnA' - m : major, 0 ~ 9
 *            nn: minor, 00~99 binary coded dicimal
 *   'rr'   - rev, 00~99 binary coded dicimal
 */
static const char *parrot_ec_fw_version(struct platform_intf *intf)
{
	uint8_t major, minor, rev;
	static char version[11];

	if (ene_kb932_detect(intf, parrot_ec_port))
		memcpy(version, "00BExxxAxx", 11);
	else
		return "Unknown";

	/* get 3 bytes firmware version */
	ec_cmd(intf, cmd_fw_version);

	/* major range: 0 ~ 9 */
	if (!ec_read(intf, parrot_ec_data, &major)) {
		if (major < 10)
			version[4] = major + '0';
	}
	/* minor range: 00 ~ 99 */
	if (!ec_read(intf, parrot_ec_data, &minor))
		bcd_to_ascii(minor, version + 5);
	/* rev range: 00 ~ 99 */
	if (!ec_read(intf, parrot_ec_data, &rev))
		bcd_to_ascii(rev, version + 8);

	return version;
}


struct ec_cb parrot_ec_cb = {
	.vendor		= parrot_ec_vendor,
	.name		= parrot_ec_name,
	.fw_version	= parrot_ec_fw_version,
};