A small utility to dump the RAM of a laptop's Embedded/Environmental

Controller. Nothing fancy, does not know any laptops, EC types, or what
the values mean. It just dumps them. For the dump method, have a look at
the ACPI 3.0b spec.

Signed-off-by: Stefan Reinauer <stepan@coresystems.de>
Acked-by: Uwe Hermann <uwe@hermann-uwe.de>



git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4163 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

4 files changed, 306 insertions, 0 deletions

diff --git a/util/ectool/Makefile b/util/ectool/Makefile
new file mode 100644
index 0000000000..7e92f68e85
--- /dev/null
+++ b/util/ectool/Makefile
@@ -0,0 +1,34 @@
+#
+# Makefile for ectool
+#
+# Copyright (C) 2009 by coresystems GmbH 
+# written by Stefan Reinauer <stepan@coresystems.de> 
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+
+CC=gcc
+CFLAGS=-O2 -Wall -W
+
+all: ectool
+
+ectool: ec.o ectool.o
+	$(CC) $(CFLAGS) -o $@ $^
+	
+clean:
+	rm *.o ectool
+
+%.o: %.c
+	$(CC) $(CFLAGS) -c $^ -I. -o $@
diff --git a/util/ectool/ec.c b/util/ectool/ec.c
new file mode 100644
index 0000000000..9fa81258b7
--- /dev/null
+++ b/util/ectool/ec.c
@@ -0,0 +1,119 @@
+/*
+ * This file is part of the ectool project.
+ *
+ * Copyright (C) 2008-2009 coresystems GmbH
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; version 2 of
+ * the License.
+ *
+ * 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
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <sys/io.h>
+#include "ec.h"
+
+extern int verbose;
+
+#define debug(x...) if (verbose) printf(x)
+
+int send_ec_command(uint8_t command)
+{
+	int timeout;
+
+	timeout = 0x7ff;
+	while ((inb(EC_SC) & EC_IBF) && --timeout) {
+		usleep(10);
+		if ((timeout & 0xff) == 0)
+			debug(".");
+	}
+	if (!timeout) {
+		printf("Timeout while sending command 0x%02x to EC!\n", 
+				command);
+		// return -1;
+	}
+
+	outb(command, EC_SC);
+	return 0;
+}
+
+int send_ec_data(uint8_t data)
+{
+	int timeout;
+
+	timeout = 0x7ff;
+	while ((inb(EC_SC) & EC_IBF) && --timeout) { // wait for IBF = 0
+		usleep(10);
+		if ((timeout & 0xff) == 0)
+			debug(".");
+	}
+	if (!timeout) {
+		printf("Timeout while sending data 0x%02x to EC!\n",
+				data);
+		// return -1;
+	}
+
+	outb(data, EC_DATA);
+
+	return 0;
+}
+
+int send_ec_data_nowait(uint8_t data)
+{
+	outb(data, EC_DATA);
+
+	return 0;
+}
+
+uint8_t recv_ec_data(void)
+{
+	int timeout;
+	uint8_t data;
+
+	timeout = 0x7fff;
+	while (--timeout) { // Wait for OBF = 1
+		if (inb(EC_SC) & EC_OBF) {
+			break;
+		}
+		usleep(10);
+		if ((timeout & 0xff) == 0)
+			debug(".");
+	}
+	if (!timeout) {
+		printf("\nTimeout while receiving data from EC!\n");
+		// return -1;
+	}
+
+	data = inb(EC_DATA);
+	debug("recv_ec_data: 0x%02x\n", data);
+
+	return data;
+}
+
+uint8_t ec_read(uint8_t addr)
+{
+	send_ec_command(0x80);
+	send_ec_data(addr);
+
+	return recv_ec_data();
+}
+
+int ec_write(uint8_t addr, uint8_t data)
+{
+	send_ec_command(0x81);
+	send_ec_data(addr);
+	return send_ec_data(data);
+}
+
diff --git a/util/ectool/ec.h b/util/ectool/ec.h
new file mode 100644
index 0000000000..dde1ba313a
--- /dev/null
+++ b/util/ectool/ec.h
@@ -0,0 +1,49 @@
+/*
+ * This file is part of the ectool project.
+ *
+ * Copyright (C) 2008-2009 coresystems GmbH
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; version 2 of
+ * the License.
+ *
+ * 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
+ */
+
+#ifndef _EC_H
+#define _EC_H
+#include <stdint.h>
+#define EC_DATA	0x62
+#define EC_SC	0x66
+
+/* EC_SC input */
+#define   EC_SMI_EVT	(1 << 6) // 1: SMI event pending
+#define   EC_SCI_EVT	(1 << 5) // 1: SCI event pending
+#define   EC_BURST	(1 << 4) // controller is in burst mode
+#define   EC_CMD	(1 << 3) // 1: byte in data register is command
+				 // 0: byte in data register is data
+#define   EC_IBF	(1 << 1) // 1: input buffer full (data ready for ec)
+#define   EC_OBF	(1 << 0) // 1: output buffer full (data ready for host)
+/* EC_SC output */
+#define   RD_EC		0x80 // Read Embedded Controller
+#define   WR_EC		0x81 // Write Embedded Controller
+#define   BE_EC		0x82 // Burst Enable Embedded Controller
+#define   BD_EC 	0x83 // Burst Disable Embedded Controller
+#define   QR_EC 	0x84 // Query Embedded Controller
+
+int send_ec_command(uint8_t command);
+int send_ec_data(uint8_t data);
+int send_ec_data_nowait(uint8_t data);
+uint8_t recv_ec_data(void);
+uint8_t ec_read(uint8_t addr);
+#endif
+
diff --git a/util/ectool/ectool.c b/util/ectool/ectool.c
new file mode 100644
index 0000000000..6c1441ec1c
--- /dev/null
+++ b/util/ectool/ectool.c
@@ -0,0 +1,104 @@
+/*
+ * This file is part of the ectool project.
+ *
+ * Copyright (C) 2008-2009 coresystems GmbH
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; version 2 of
+ * the License.
+ *
+ * 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
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <getopt.h>
+#include <sys/io.h>
+#include <ec.h>
+
+#define ECTOOL_VERSION "0.1"
+
+void print_version(void)
+{
+	printf("ectool v%s -- ", ECTOOL_VERSION);
+	printf("Copyright (C) 2008-2009 coresystems GmbH\n\n");
+	printf(
+    "This program is free software: you can redistribute it and/or modify\n"
+    "it under the terms of the GNU General Public License as published by\n"
+    "the Free Software Foundation, version 2 of the License.\n\n"
+    "This program is distributed in the hope that it will be useful,\n"
+    "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
+    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n"
+    "GNU General Public License for more details.\n\n"
+    "You should have received a copy of the GNU General Public License\n"
+    "along with this program.  If not, see <http://www.gnu.org/licenses/>.\n\n");
+}
+
+void print_usage(const char *name)
+{
+	printf("usage: %s [-vh?V]\n", name);
+	printf("\n"
+	     "   -v | --version:                   print the version\n"
+	     "   -h | --help:                      print this help\n\n"
+	     "   -V | --verbose:                   print debug information\n"
+	     "\n");
+	exit(1);
+}
+
+int verbose = 0;
+
+int main(int argc, char *argv[])
+{
+	int i, opt, option_index = 0;
+
+	static struct option long_options[] = {
+		{"version", 0, 0, 'v'},
+		{"help", 0, 0, 'h'},
+		{"verbose", 0, 0, 'V'},
+		{0, 0, 0, 0}
+	};
+
+	while ((opt = getopt_long(argc, argv, "vh?V",
+                                  long_options, &option_index)) != EOF) {
+		switch (opt) {
+		case 'v':
+			print_version();
+			exit(0);
+			break;
+		case 'V':
+			verbose = 1;
+			break;
+		case 'h':
+		case '?':
+		default:
+			print_usage(argv[0]);
+			exit(0);
+			break;
+		}
+	}
+
+	if (iopl(3)) {
+		printf("You need to be root.\n");
+		exit(1);
+	}
+
+	printf("EC RAM:\n");
+	for (i=0; i < 0x100; i++) {
+		if ((i % 0x10) == 0) 
+			printf ("\n%02x: ", i);
+		printf("%02x ", ec_read(i));
+	}
+	printf("\n\n");
+	return 0;
+}