[mirror_ubuntu-bionic-kernel.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.
  
  Some of the constants in here are from the corresponding
  NetBSD/OpenBSD header file, by Allen Briggs.  We figured out the
  rest of them on our own. */
#ifndef LINUX_NUBUS_H
#define LINUX_NUBUS_H

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

struct nubus_board {
	struct nubus_board* next;
	struct nubus_dev* first_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;
};

struct nubus_dev {
	/* Next link in device list */
	struct nubus_dev* next;
	/* Directory entry in /proc/bus/nubus */
	struct proc_dir_entry* procdir;

	/* The functional resource ID of this device */
	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;
	/* This is the device's name rather than the board's.
	   Sometimes they are different.  Usually the board name is
	   more correct. */
	char name[64];
	/* MacOS driver (I kid you not) */
	unsigned char* driver;
	/* Actually this is an offset */
	unsigned long iobase;
	unsigned long iosize;
	unsigned char flags, hwdevid;
	
	/* Functional directory */
	unsigned char* directory;
	/* Much of our info comes from here */
	struct nubus_board* board;
};

/* This is all NuBus devices (used to find devices later on) */
extern struct nubus_dev* nubus_devices;
/* This is all NuBus cards */
extern struct nubus_board* nubus_boards;

/* Generic NuBus interface functions, modelled after the PCI interface */
void nubus_scan_bus(void);
#ifdef CONFIG_PROC_FS
extern void nubus_proc_init(void);
#else
static inline void nubus_proc_init(void) {}
#endif
int get_nubus_list(char *buf);
int nubus_proc_attach_device(struct nubus_dev *dev);
/* If we need more precision we can add some more of these */
struct nubus_dev* nubus_find_device(unsigned short category,
				    unsigned short type,
				    unsigned short dr_hw,
				    unsigned short dr_sw,
				    const struct nubus_dev* from);
struct nubus_dev* nubus_find_type(unsigned short category,
				  unsigned short type,
				  const struct nubus_dev* from);
/* Might have more than one device in a slot, you know... */
struct nubus_dev* nubus_find_slot(unsigned int slot,
				  const struct nubus_dev* from);

/* 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_dev* dev,
		       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,
			int len);
void nubus_get_rsrc_str(void* dest,
			const struct nubus_dirent *dirent,
			int maxlen);
#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.
	8
	9	Some of the constants in here are from the corresponding
	10	NetBSD/OpenBSD header file, by Allen Briggs. We figured out the
	11	rest of them on our own. */
1da177e4 LT	12	#ifndef LINUX_NUBUS_H
	13	#define LINUX_NUBUS_H
	14
1da177e4	15	#include <asm/nubus.h>
607ca46e	16	#include <uapi/linux/nubus.h>
1da177e4	17
1da177e4 LT	18	struct nubus_board {
	19	struct nubus_board* next;
	20	struct nubus_dev* first_dev;
	21
f8779588	22	/* Only 9-E actually exist, though 0-8 are also theoretically
1da177e4 LT	23	possible, and 0 is a special case which represents the
	24	motherboard and onboard peripherals (Ethernet, video) */
	25	int slot;
	26	/* For slot 0, this is bogus. */
	27	char name[64];
	28
	29	/* Format block */
	30	unsigned char* fblock;
	31	/* Root directory (does not always equal fblock + doffset!) */
	32	unsigned char* directory;
	33
	34	unsigned long slot_addr;
	35	/* Offset to root directory (sometimes) */
	36	unsigned long doffset;
	37	/* Length over which to compute the crc */
	38	unsigned long rom_length;
	39	/* Completely useless most of the time */
	40	unsigned long crc;
	41	unsigned char rev;
	42	unsigned char format;
	43	unsigned char lanes;
	44	};
	45
	46	struct nubus_dev {
	47	/* Next link in device list */
	48	struct nubus_dev* next;
	49	/* Directory entry in /proc/bus/nubus */
	50	struct proc_dir_entry* procdir;
	51
	52	/* The functional resource ID of this device */
	53	unsigned char resid;
	54	/* These are mostly here for convenience; we could always read
	55	them from the ROMs if we wanted to */
	56	unsigned short category;
	57	unsigned short type;
	58	unsigned short dr_sw;
	59	unsigned short dr_hw;
	60	/* This is the device's name rather than the board's.
	61	Sometimes they are different. Usually the board name is
	62	more correct. */
	63	char name[64];
	64	/* MacOS driver (I kid you not) */
	65	unsigned char* driver;
	66	/* Actually this is an offset */
	67	unsigned long iobase;
	68	unsigned long iosize;
	69	unsigned char flags, hwdevid;
	70
	71	/* Functional directory */
	72	unsigned char* directory;
	73	/* Much of our info comes from here */
	74	struct nubus_board* board;
	75	};
	76
	77	/* This is all NuBus devices (used to find devices later on) */
	78	extern struct nubus_dev* nubus_devices;
	79	/* This is all NuBus cards */
	80	extern struct nubus_board* nubus_boards;
	81
	82	/* Generic NuBus interface functions, modelled after the PCI interface */
	83	void nubus_scan_bus(void);
11db656a	84	#ifdef CONFIG_PROC_FS
1da177e4	85	extern void nubus_proc_init(void);
11db656a DH	86	#else
	87	static inline void nubus_proc_init(void) {}
	88	#endif
1da177e4 LT	89	int get_nubus_list(char *buf);
1da177e4 LT	90	int nubus_proc_attach_device(struct nubus_dev *dev);
1da177e4 LT	91	/* If we need more precision we can add some more of these */
	92	struct nubus_dev* nubus_find_device(unsigned short category,
	93	unsigned short type,
	94	unsigned short dr_hw,
	95	unsigned short dr_sw,
	96	const struct nubus_dev* from);
	97	struct nubus_dev* nubus_find_type(unsigned short category,
	98	unsigned short type,
	99	const struct nubus_dev* from);
	100	/* Might have more than one device in a slot, you know... */
	101	struct nubus_dev* nubus_find_slot(unsigned int slot,
	102	const struct nubus_dev* from);
	103
	104	/* These are somewhat more NuBus-specific. They all return 0 for
	105	success and -1 for failure, as you'd expect. */
	106
	107	/* The root directory which contains the board and functional
	108	directories */
	109	int nubus_get_root_dir(const struct nubus_board* board,
	110	struct nubus_dir* dir);
	111	/* The board directory */
	112	int nubus_get_board_dir(const struct nubus_board* board,
	113	struct nubus_dir* dir);
	114	/* The functional directory */
	115	int nubus_get_func_dir(const struct nubus_dev* dev,
	116	struct nubus_dir* dir);
	117
	118	/* These work on any directory gotten via the above */
	119	int nubus_readdir(struct nubus_dir* dir,
	120	struct nubus_dirent* ent);
	121	int nubus_find_rsrc(struct nubus_dir* dir,
	122	unsigned char rsrc_type,
	123	struct nubus_dirent* ent);
	124	int nubus_rewinddir(struct nubus_dir* dir);
	125
	126	/* Things to do with directory entries */
	127	int nubus_get_subdir(const struct nubus_dirent* ent,
	128	struct nubus_dir* dir);
	129	void nubus_get_rsrc_mem(void* dest,
	130	const struct nubus_dirent *dirent,
	131	int len);
	132	void nubus_get_rsrc_str(void* dest,
	133	const struct nubus_dirent *dirent,
	134	int maxlen);
1da177e4	135	#endif /* LINUX_NUBUS_H */