/*
 * (C) Copyright 2008 Openmoko, Inc.
 * Author: Andy Green <andy@openmoko.org>
 *
 * 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., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

#ifndef __QI_H__
#define __QI_H__

#include <stdarg.h>
#include <qi-ctype.h>
#include <asm/byteorder.h>

#define MALLOC_POOL_EXTENT (100 * 1024)

#define u32 unsigned int
#define u16 unsigned short
#define u8 unsigned char
typedef unsigned int uint32_t;
typedef unsigned short uint16_t;
typedef unsigned char uint8_t;

#define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))

enum filesystem {
	FS_RAW,
	FS_FAT,
	FS_EXT2
};

enum ui_actions {
	UI_ACTION_ADD_DEBUG 	= (1 << 0),
	UI_ACTION_SKIPKERNEL	= (1 << 1),
};

enum ui_indication {
	UI_IND_UPDATE_ONLY,
	UI_IND_MOUNT_PART,
	UI_IND_MOUNT_FAIL,
	UI_IND_SKIPPING,
	UI_IND_KERNEL_PULL,
	UI_IND_KERNEL_PULL_OK,
	UI_IND_KERNEL_PULL_FAIL,
	UI_IND_INITRAMFS_PULL,
	UI_IND_INITRAMFS_PULL_OK,
	UI_IND_INITRAMFS_PULL_FAIL,
	UI_IND_KERNEL_START,
	UI_IND_MEM_TEST
};

/* describes a source for getting kernel image */

struct kernel_source {
	const char *name; /* NULL name means invalid */
	const char *filepath;
	const char *initramfs_filepath;
	int (*block_init)(void);
	int (*block_read)(unsigned char * buf, unsigned long start512,
							       int blocks512);
	int partition_index; /* -1 means no partition table */
	int offset_blocks512_if_no_partition; /* used if partition_index is -1 */
	enum filesystem filesystem;
	const char * commandline_append;
};

/* describes a board variant, eg, PCB revision */

struct board_variant {
	const char * name;
	int machine_revision; /* passed in revision tag to linux */
};

/* describes a "board", ie, a device like GTA02 including revisions */

struct board_api {
	const char * name;
	int linux_machine_id;
	unsigned long linux_mem_start;
	unsigned long linux_mem_size;
	unsigned long linux_tag_placement;
	const char *commandline_board;
	const char *commandline_board_debug;
	const char *noboot;
	const char *append;

	const struct board_variant const * (*get_board_variant)(void);
	int (*is_this_board)(void);
	void (*early_port_init)(void);
	void (*port_init)(void);
	void (*post_serial_init)(void); /* print device-specific things */
	char * (*append_device_specific_cmdline)(char *);
	void (*putc)(char);
	void (*close)(void);
	u8 (*get_ui_keys)(void);
	u8 (*get_ui_debug)(void);
	void (*set_ui_indication)(enum ui_indication);

	struct kernel_source kernel_source[8];
};

/* this is the board we are running on */

extern struct board_api const * this_board;
extern struct kernel_source const * this_kernel;

int printk(const char *fmt, ...);
int vsprintf(char *buf, const char *fmt, va_list args);
int puts(const char *string);
void printhex(unsigned char v);
void print8(unsigned char u);
void print32(unsigned int u);
void printdec(int n);
void hexdump(unsigned char *start, int len);
void udelay(int n);

/* phase2 only */
void setnybble(char *p, unsigned char n);
void set8(char *p, unsigned char n);
void set32(char *p, unsigned int u);

unsigned long crc32(unsigned long crc, const unsigned char *buf,
							      unsigned int len);
int nand_read_ll(unsigned char *buf, unsigned long start512, int blocks512);

extern void memory_test(void * start, unsigned int length);

void set_putc_func(void (*p)(char));

#endif