[linux-2.6-block.git] / include / linux / nubus.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
  nubus.h: various definitions and prototypes for NuBus drivers to use.

  Originally written by Alan Cox.

  Hacked to death by C. Scott Ananian and David Huggins-Daines.
*/

#ifndef LINUX_NUBUS_H
#define LINUX_NUBUS_H

#include <linux/device.h>
#include <asm/nubus.h>
#include <uapi/linux/nubus.h>

struct proc_dir_entry;
struct seq_file;

struct nubus_dir {
	unsigned char *base;
	unsigned char *ptr;
	int done;
	int mask;
	struct proc_dir_entry *procdir;
};

struct nubus_dirent {
	unsigned char *base;
	unsigned char type;
	__u32 data;	/* Actually 24 bits used */
	int mask;
};

struct nubus_board {
	struct device dev;

	/* Only 9-E actually exist, though 0-8 are also theoretically
	   possible, and 0 is a special case which represents the
	   motherboard and onboard peripherals (Ethernet, video) */
	int slot;
	/* For slot 0, this is bogus. */
	char name[64];

	/* Format block */
	unsigned char *fblock;
	/* Root directory (does *not* always equal fblock + doffset!) */
	unsigned char *directory;

	unsigned long slot_addr;
	/* Offset to root directory (sometimes) */
	unsigned long doffset;
	/* Length over which to compute the crc */
	unsigned long rom_length;
	/* Completely useless most of the time */
	unsigned long crc;
	unsigned char rev;
	unsigned char format;
	unsigned char lanes;

	/* Directory entry in /proc/bus/nubus */
	struct proc_dir_entry *procdir;
};

struct nubus_rsrc {
	struct list_head list;

	/* The functional resource ID */
	unsigned char resid;
	/* These are mostly here for convenience; we could always read
	   them from the ROMs if we wanted to */
	unsigned short category;
	unsigned short type;
	unsigned short dr_sw;
	unsigned short dr_hw;

	/* Functional directory */
	unsigned char *directory;
	/* Much of our info comes from here */
	struct nubus_board *board;
};

/* This is all NuBus functional resources (used to find devices later on) */
extern struct list_head nubus_func_rsrcs;

struct nubus_driver {
	struct device_driver driver;
	int (*probe)(struct nubus_board *board);
	void (*remove)(struct nubus_board *board);
};

/* Generic NuBus interface functions, modelled after the PCI interface */
#ifdef CONFIG_PROC_FS
extern bool nubus_populate_procfs;
void nubus_proc_init(void);
struct proc_dir_entry *nubus_proc_add_board(struct nubus_board *board);
struct proc_dir_entry *nubus_proc_add_rsrc_dir(struct proc_dir_entry *procdir,
					       const struct nubus_dirent *ent,
					       struct nubus_board *board);
void nubus_proc_add_rsrc_mem(struct proc_dir_entry *procdir,
			     const struct nubus_dirent *ent,
			     unsigned int size);
void nubus_proc_add_rsrc(struct proc_dir_entry *procdir,
			 const struct nubus_dirent *ent);
#else
static inline void nubus_proc_init(void) {}
static inline
struct proc_dir_entry *nubus_proc_add_board(struct nubus_board *board)
{ return NULL; }
static inline
struct proc_dir_entry *nubus_proc_add_rsrc_dir(struct proc_dir_entry *procdir,
					       const struct nubus_dirent *ent,
					       struct nubus_board *board)
{ return NULL; }
static inline void nubus_proc_add_rsrc_mem(struct proc_dir_entry *procdir,
					   const struct nubus_dirent *ent,
					   unsigned int size) {}
static inline void nubus_proc_add_rsrc(struct proc_dir_entry *procdir,
				       const struct nubus_dirent *ent) {}
#endif

struct nubus_rsrc *nubus_first_rsrc_or_null(void);
struct nubus_rsrc *nubus_next_rsrc_or_null(struct nubus_rsrc *from);

#define for_each_func_rsrc(f) \
	for (f = nubus_first_rsrc_or_null(); f; f = nubus_next_rsrc_or_null(f))

#define for_each_board_func_rsrc(b, f) \
	for_each_func_rsrc(f) if (f->board != b) {} else

/* These are somewhat more NuBus-specific.  They all return 0 for
   success and -1 for failure, as you'd expect. */

/* The root directory which contains the board and functional
   directories */
int nubus_get_root_dir(const struct nubus_board *board,
		       struct nubus_dir *dir);
/* The board directory */
int nubus_get_board_dir(const struct nubus_board *board,
			struct nubus_dir *dir);
/* The functional directory */
int nubus_get_func_dir(const struct nubus_rsrc *fres, struct nubus_dir *dir);

/* These work on any directory gotten via the above */
int nubus_readdir(struct nubus_dir *dir,
		  struct nubus_dirent *ent);
int nubus_find_rsrc(struct nubus_dir *dir,
		    unsigned char rsrc_type,
		    struct nubus_dirent *ent);
int nubus_rewinddir(struct nubus_dir *dir);

/* Things to do with directory entries */
int nubus_get_subdir(const struct nubus_dirent *ent,
		     struct nubus_dir *dir);
void nubus_get_rsrc_mem(void *dest, const struct nubus_dirent *dirent,
			unsigned int len);
unsigned int nubus_get_rsrc_str(char *dest, const struct nubus_dirent *dirent,
				unsigned int len);
void nubus_seq_write_rsrc_mem(struct seq_file *m,
			      const struct nubus_dirent *dirent,
			      unsigned int len);
unsigned char *nubus_dirptr(const struct nubus_dirent *nd);

/* Declarations relating to driver model objects */
int nubus_parent_device_register(void);
int nubus_device_register(struct nubus_board *board);
int nubus_driver_register(struct nubus_driver *ndrv);
void nubus_driver_unregister(struct nubus_driver *ndrv);
int nubus_proc_show(struct seq_file *m, void *data);

static inline void nubus_set_drvdata(struct nubus_board *board, void *data)
{
	dev_set_drvdata(&board->dev, data);
}

static inline void *nubus_get_drvdata(struct nubus_board *board)
{
	return dev_get_drvdata(&board->dev);
}

/* Returns a pointer to the "standard" slot space. */
static inline void *nubus_slot_addr(int slot)
{
	return (void *)(0xF0000000 | (slot << 24));
}

#endif /* LINUX_NUBUS_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	nubus.h: various definitions and prototypes for NuBus drivers to use.
	4
	5	Originally written by Alan Cox.
	6
	7	Hacked to death by C. Scott Ananian and David Huggins-Daines.
1ff2775a FT	8	*/
1ff2775a FT	9
1da177e4 LT	10	#ifndef LINUX_NUBUS_H
	11	#define LINUX_NUBUS_H
	12
7f86c765	13	#include <linux/device.h>
1da177e4	14	#include <asm/nubus.h>
607ca46e	15	#include <uapi/linux/nubus.h>
1da177e4	16
2f7dd07e FT	17	struct proc_dir_entry;
	18	struct seq_file;
	19
1ff2775a FT	20	struct nubus_dir {
	21	unsigned char *base;
	22	unsigned char *ptr;
	23	int done;
	24	int mask;
2f7dd07e	25	struct proc_dir_entry *procdir;
1ff2775a FT	26	};
	27
	28	struct nubus_dirent {
	29	unsigned char *base;
	30	unsigned char type;
	31	__u32 data; /* Actually 24 bits used */
	32	int mask;
	33	};
	34
1da177e4	35	struct nubus_board {
7f86c765	36	struct device dev;
4bccc4b6	37
f8779588	38	/* Only 9-E actually exist, though 0-8 are also theoretically
1da177e4 LT	39	possible, and 0 is a special case which represents the
	40	motherboard and onboard peripherals (Ethernet, video) */
	41	int slot;
	42	/* For slot 0, this is bogus. */
	43	char name[64];
	44
	45	/* Format block */
4bccc4b6	46	unsigned char *fblock;
1da177e4	47	/* Root directory (does not always equal fblock + doffset!) */
4bccc4b6 FT	48	unsigned char *directory;
4bccc4b6 FT	49
1da177e4 LT	50	unsigned long slot_addr;
	51	/* Offset to root directory (sometimes) */
	52	unsigned long doffset;
	53	/* Length over which to compute the crc */
	54	unsigned long rom_length;
	55	/* Completely useless most of the time */
	56	unsigned long crc;
	57	unsigned char rev;
	58	unsigned char format;
	59	unsigned char lanes;
6c8b89ea FT	60
	61	/* Directory entry in /proc/bus/nubus */
	62	struct proc_dir_entry *procdir;
1da177e4 LT	63	};
1da177e4 LT	64
189e19e8	65	struct nubus_rsrc {
41b84816	66	struct list_head list;
1da177e4	67
189e19e8	68	/* The functional resource ID */
1da177e4 LT	69	unsigned char resid;
	70	/* These are mostly here for convenience; we could always read
	71	them from the ROMs if we wanted to */
	72	unsigned short category;
	73	unsigned short type;
	74	unsigned short dr_sw;
	75	unsigned short dr_hw;
4bccc4b6	76
1da177e4	77	/* Functional directory */
4bccc4b6	78	unsigned char *directory;
1da177e4	79	/* Much of our info comes from here */
4bccc4b6	80	struct nubus_board *board;
1da177e4 LT	81	};
1da177e4 LT	82
189e19e8	83	/* This is all NuBus functional resources (used to find devices later on) */
41b84816	84	extern struct list_head nubus_func_rsrcs;
7f86c765 FT	85
	86	struct nubus_driver {
	87	struct device_driver driver;
	88	int (probe)(struct nubus_board board);
b2c943e5	89	void (remove)(struct nubus_board board);
7f86c765 FT	90	};
7f86c765 FT	91
1da177e4	92	/* Generic NuBus interface functions, modelled after the PCI interface */
11db656a	93	#ifdef CONFIG_PROC_FS
72b44f65	94	extern bool nubus_populate_procfs;
2f7dd07e FT	95	void nubus_proc_init(void);
	96	struct proc_dir_entry nubus_proc_add_board(struct nubus_board board);
	97	struct proc_dir_entry nubus_proc_add_rsrc_dir(struct proc_dir_entry procdir,
	98	const struct nubus_dirent *ent,
	99	struct nubus_board *board);
	100	void nubus_proc_add_rsrc_mem(struct proc_dir_entry *procdir,
	101	const struct nubus_dirent *ent,
	102	unsigned int size);
	103	void nubus_proc_add_rsrc(struct proc_dir_entry *procdir,
	104	const struct nubus_dirent *ent);
11db656a DH	105	#else
11db656a DH	106	static inline void nubus_proc_init(void) {}
2f7dd07e FT	107	static inline
	108	struct proc_dir_entry nubus_proc_add_board(struct nubus_board board)
	109	{ return NULL; }
	110	static inline
	111	struct proc_dir_entry nubus_proc_add_rsrc_dir(struct proc_dir_entry procdir,
	112	const struct nubus_dirent *ent,
	113	struct nubus_board *board)
	114	{ return NULL; }
	115	static inline void nubus_proc_add_rsrc_mem(struct proc_dir_entry *procdir,
	116	const struct nubus_dirent *ent,
	117	unsigned int size) {}
	118	static inline void nubus_proc_add_rsrc(struct proc_dir_entry *procdir,
	119	const struct nubus_dirent *ent) {}
11db656a	120	#endif
9f97977d	121
41b84816 FT	122	struct nubus_rsrc *nubus_first_rsrc_or_null(void);
41b84816 FT	123	struct nubus_rsrc nubus_next_rsrc_or_null(struct nubus_rsrc from);
189e19e8	124
41b84816 FT	125	#define for_each_func_rsrc(f) \
41b84816 FT	126	for (f = nubus_first_rsrc_or_null(); f; f = nubus_next_rsrc_or_null(f))
1da177e4	127
7f86c765 FT	128	#define for_each_board_func_rsrc(b, f) \
	129	for_each_func_rsrc(f) if (f->board != b) {} else
	130
1da177e4 LT	131	/* These are somewhat more NuBus-specific. They all return 0 for
	132	success and -1 for failure, as you'd expect. */
	133
	134	/* The root directory which contains the board and functional
	135	directories */
4bccc4b6 FT	136	int nubus_get_root_dir(const struct nubus_board *board,
4bccc4b6 FT	137	struct nubus_dir *dir);
1da177e4	138	/* The board directory */
4bccc4b6 FT	139	int nubus_get_board_dir(const struct nubus_board *board,
4bccc4b6 FT	140	struct nubus_dir *dir);
1da177e4	141	/* The functional directory */
189e19e8	142	int nubus_get_func_dir(const struct nubus_rsrc fres, struct nubus_dir dir);
1da177e4 LT	143
1da177e4 LT	144	/* These work on any directory gotten via the above */
4bccc4b6 FT	145	int nubus_readdir(struct nubus_dir *dir,
	146	struct nubus_dirent *ent);
	147	int nubus_find_rsrc(struct nubus_dir *dir,
1da177e4	148	unsigned char rsrc_type,
4bccc4b6 FT	149	struct nubus_dirent *ent);
4bccc4b6 FT	150	int nubus_rewinddir(struct nubus_dir *dir);
1da177e4 LT	151
1da177e4 LT	152	/* Things to do with directory entries */
4bccc4b6 FT	153	int nubus_get_subdir(const struct nubus_dirent *ent,
4bccc4b6 FT	154	struct nubus_dir *dir);
2f828fb2 FT	155	void nubus_get_rsrc_mem(void dest, const struct nubus_dirent dirent,
2f828fb2 FT	156	unsigned int len);
2f7dd07e FT	157	unsigned int nubus_get_rsrc_str(char dest, const struct nubus_dirent dirent,
	158	unsigned int len);
	159	void nubus_seq_write_rsrc_mem(struct seq_file *m,
	160	const struct nubus_dirent *dirent,
	161	unsigned int len);
	162	unsigned char nubus_dirptr(const struct nubus_dirent nd);
1ff2775a	163
7f86c765	164	/* Declarations relating to driver model objects */
bdeeed09	165	int nubus_parent_device_register(void);
7f86c765 FT	166	int nubus_device_register(struct nubus_board *board);
	167	int nubus_driver_register(struct nubus_driver *ndrv);
	168	void nubus_driver_unregister(struct nubus_driver *ndrv);
	169	int nubus_proc_show(struct seq_file m, void data);
	170
	171	static inline void nubus_set_drvdata(struct nubus_board board, void data)
	172	{
	173	dev_set_drvdata(&board->dev, data);
	174	}
	175
	176	static inline void nubus_get_drvdata(struct nubus_board board)
	177	{
	178	return dev_get_drvdata(&board->dev);
	179	}
	180
1ff2775a FT	181	/* Returns a pointer to the "standard" slot space. */
	182	static inline void *nubus_slot_addr(int slot)
	183	{
	184	return (void *)(0xF0000000 \| (slot << 24));
	185	}
	186
1da177e4	187	#endif /* LINUX_NUBUS_H */