mini/ipc.h

/*
	mini - a Free Software replacement for the Nintendo/BroadOn IOS.

	inter-processor communications

Copyright (C) 2008, 2009	Hector Martin "marcan" <marcan@marcansoft.com>
Copyright (C) 2008, 2009	Haxx Enterprises <bushing@gmail.com>
Copyright (C) 2008, 2009	Sven Peter <svenpeter@gmail.com>
Copyright (C) 2009			Andre Heider "dhewg" <dhewg@wiibrew.org>
Copyright (C) 2009		John Kelley <wiidev@kelley.ca>

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.

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 __IPC_H__
#define __IPC_H__

#include "types.h"


/* For the sake of interface compatibility between mini and powerpc code,
   you should try to commit any enhancements you make back upstream so
   that they can be assigned a standard request number.  Otherwise, if
   you are creating a new device, you MUST assign it a device ID >= 0x80.

   Likewise, if you add functionality to any of the existing drivers,
   your must assign it to a request ID >= 0x8000.  This will prevent
   problems if a mismatch between ARM and PPC code occurs.  Similarly,
   if you add functions, you should always add them to the end, to
   prevent someone from calling the wrong function.

   Even still, you are encouraged to add in sanity checks and version
   checking to prevent strange bugs or even data loss.  --bushing */

#define IPC_FAST	0x01
#define IPC_SLOW	0x00

#define IPC_DEV_SYS	0x00
#define IPC_DEV_NAND	0x01
#define IPC_DEV_SDHC	0x02
#define IPC_DEV_KEYS	0x03
#define IPC_DEV_AES	0x04
#define IPC_DEV_BOOT2	0x05
#define IPC_DEV_PPC	0x06
#define IPC_DEV_SDMMC	0x07

//#define IPC_DEV_USER0 0x80
//#define IPC_DEV_USER1 0x81

#define IPC_SYS_PING	0x0000
#define IPC_SYS_JUMP	0x0001
#define IPC_SYS_GETVERS 0x0002
#define IPC_SYS_WRITE32	0x0100
#define IPC_SYS_WRITE16	0x0101
#define IPC_SYS_WRITE8	0x0102
#define IPC_SYS_READ32	0x0103
#define IPC_SYS_READ16	0x0104
#define IPC_SYS_READ8	0x0105
#define IPC_SYS_SET32	0x0106
#define IPC_SYS_SET16	0x0107
#define IPC_SYS_SET8	0x0108
#define IPC_SYS_CLEAR32	0x0109
#define IPC_SYS_CLEAR16	0x010a
#define IPC_SYS_CLEAR8	0x010b
#define IPC_SYS_MASK32	0x010c
#define IPC_SYS_MASK16	0x010d
#define IPC_SYS_MASK8	0x010e

#define IPC_NAND_RESET	0x0000
#define IPC_NAND_GETID	0x0001
#define IPC_NAND_READ	0x0002
#define IPC_NAND_WRITE	0x0003
#define IPC_NAND_ERASE	0x0004
#define IPC_NAND_STATUS	0x0005
//#define IPC_NAND_USER0 0x8000
//#define IPC_NAND_USER1 0x8001
// etc.

#define IPC_SDHC_DISCOVER 0x0000

#define IPC_SDMMC_ACK	0x0000
#define IPC_SDMMC_READ	0x0001
#define IPC_SDMMC_WRITE	0x0002
#define IPC_SDMMC_STATE 0x0003
#define IPC_SDMMC_SIZE	0x0004

#define IPC_KEYS_GETOTP	0x0000
#define IPC_KEYS_GETEEP	0x0001

#define IPC_AES_RESET	0x0000
#define IPC_AES_SETIV	0x0001
#define	IPC_AES_SETKEY	0x0002
#define	IPC_AES_DECRYPT	0x0003

#define IPC_BOOT2_RUN	0x0000
#define IPC_BOOT2_TMD	0x0001

#define IPC_PPC_BOOT	0x0000

#define IPC_CODE (f,d,r) (((f)<<24)|((d)<<16)|(r))

#define IPC_IN_SIZE	32
#define IPC_OUT_SIZE	32
#define IPC_SLOW_SIZE	128

typedef struct {
	union {
		struct {
			u8 flags;
			u8 device;
			u16 req;
		};
		u32 code;
	};
	u32 tag;
	u32 args[6];
} ipc_request;

typedef const struct {
	char magic[3];
	char version;
	void *mem2_boundary;
	volatile ipc_request *ipc_in;
	u32 ipc_in_size;
	volatile ipc_request *ipc_out;
	u32 ipc_out_size;
} ipc_infohdr;

void ipc_irq(void);

void ipc_initialize(void);
void ipc_shutdown(void);
void ipc_post(u32 code, u32 tag, u32 num_args, ...);
void ipc_flush(void);
u32  ipc_process_slow(void);

// Enqueues a request in the slow in_queue, use this in IRQ context only.
void ipc_enqueue_slow(u8 device, u16 req, u32 num_args, ...);

#endif