projects / unix-history / blob
? search:


f4be872f84dcf31982a5d2d22ab8531f1560a1e4
[unix-history] / usr / src / sys / tahoe / vba / hdreg.h
/*
* Include file for HCX Disk Controller (HDC).
*
* @(#)hdreg.h 7.1 (Berkeley) %G%
*/
#define TRUE 1
#define FALSE 0
#define HDC_READ 0
#define HDC_WRITE 1
#define HDC_MAXBUS 2 /* max# buses */
#define HDC_MAXCTLR 21 /* max# hdc controllers per bus */
#define HDC_MAXDRIVE 4 /* max# drives per hdc controller */
#define HDC_UNIT(x) (minor(x) >> 3) /* the hdc unit number (0-31) */
#define HDC_PARTITION(x) (minor(x)&0x07)/* the hdc partition number (0-7) */
#define HDC_DEFPART GB_MAXPART-1 /* partition# of def and diag cyls */
#define HDC_SPB 2 /* sectors per block for hdc's */
#define HDC_MID HID_HDC /* module id code for hdc's */
#define HDC_REMOVABLE 80 /* lowest model# for removable disks*/
#define HDC_PHIO_SIZE 256 /* lword size of physical io buffer */
#define HDC_VDATA_SIZE 16 /* vendor data size (long words) */
#define HDC_XSTAT_SIZE 128 /* size of extended status (lwords) */
#define HDC_MAXCHAIN 33 /* maximum number of data chains */
#define HDC_MAXBC 64*1024 /* maximum byte count per data chain*/
#define HDC_MAXMCBS 32 /* max# mcb's the hdc can handle */
#define HDC_MAXFLAWS 8000 /* max number of flaws per hdc disk */
#define HDC_REGISTER(x) (hc->registers->x) /* io to an hdc register */
#define HDC_DUMPSIZE HDC_MAXBC/DEV_BSIZE*HDC_MAXCHAIN
/* number of blocks per dump record */
/*
* The following buf structure defines are used by the hdc handler.
* These are required since the handler initiates strategy calls;
* these calls require more function codes than just read/write,
* and they like to directly specify the cyl/head/sector.
* Note that b_upte and B_NOT1K are never used by the handler.
*/
#define B_LOCALIO B_NOT1K
#define b_hdccommand b_upte[0]
#define b_cyl b_upte[1]
#define b_head b_upte[2]
#define b_sector b_upte[3]
/*
* These are the 4 hdc i/o register addresses.
*
* Writing to "master_mcb_reg" tells the hdc controller where the master
* mcb is and initiates hdc operation. The hdc then reads the master mcb
* and all new mcb's in the active mcb queue.
*
* Writing to "module_id_reg" causes the hdc to return the hdc's module id
* word in the location specified by the address written into the register.
*/
typedef struct {
unsigned long master_mcb_reg; /* set the master mcb address */
unsigned long module_id_reg; /* returns hdc's module id (hdc_mid)*/
unsigned long soft_reset_reg; /* a write here shuts down the hdc */
unsigned long hard_reset_reg; /* send a system reset to the hdc */
} hdc_regs_type;
/*
* Definition for the module id returned by the hdc when "module_id_reg"
* is written to. The format is defined by the hdc microcode.
*/
typedef struct {
unsigned char module_id; /* module id; hdc's return HDC_MID */
unsigned char reserved; /* */
unsigned char code_rev; /* micro-code rev#; FF= not loaded */
unsigned char fit; /* FIT test result; FF= no error */
} hdc_mid_type;
/*
* This structure defines the mcb's. A portion of this structure is
* used only by the software. The other portion is set up by software
* and sent to the hdc firmware to perform an operation; the order
* of this part of the mcb is determined by the controller firmware.
*
* "forw_mcb" and "back_mcb" form a doubly-linked list of mcb's.
*
* "context" is the software context word. The hdc firmware copies the
* the contents of this word to the master mcb whenever the mcb has been
* completed. Currently the virtual address of the mcb is saved here.
*
* "forw_phaddr" forms a linked list of mcbs. The addresses are physical
* since they are used by the hdc firmware.
*
* Bits in device control word #1 define the hdc command and
* control the operation of the hdc.
*
* Bits in device control word #2 define the disk sector address
* for the operation defined in dcw1.
*/
typedef struct {
long lwc; /* long word count & data chain bit*/
long ta; /* transfer address */
} data_chain_type;
#define LWC_DATA_CHAIN 0x80000000 /* mask for data chain bit in lwc */
struct mcb_struct ;
typedef struct mcb_struct mcb_type ;
struct mcb_struct {
/* this part used only by software */
mcb_type *forw_mcb; /* pointer to next mcb in chain */
mcb_type *back_mcb; /* pointer to previous mcb in chain */
struct buf *buf_ptr; /* ptr to buf structure for this mcb*/
long mcb_phaddr; /* phaddr of hw's part of this mcb */
/* this part is sent to the hdc hw */
unsigned long forw_phaddr; /* phys address of next mcb */
unsigned priority : 8; /* device control word #1 */
unsigned interrupt : 1; /* " */
unsigned drive : 7; /* " */
unsigned command : 16; /* " (see HCMD_) */
unsigned cyl : 13; /* device control word #2 */
unsigned head : 9; /* " */
unsigned sector : 10; /* " */
unsigned long reserved[2]; /* */
unsigned long context; /* software context word */
data_chain_type chain[HDC_MAXCHAIN];/* data chain and lword count */
} ;
/* defines for the "command"s */
#define HCMD_STATUS 0x40 /* command: read drive status */
#define HCMD_READ 0x60 /* command: read data */
#define HCMD_VENDOR 0x6A /* command: read vendor data */
#define HCMD_VERIFY 0x6D /* command: verify a track */
#define HCMD_WRITE 0x70 /* command: write data */
#define HCMD_FORMAT 0x7E /* command: format a track */
#define HCMD_CERTIFY 0x7F /* command: certify a track */
#define HCMD_WCS 0xD0 /* command: write control store */
/*
* This structure defines the master mcb - one per hdc controller.
* The order of this structure is determined by the controller firmware.
* "R" and "W" indicate read-only and write-only.
*
* Bits in the module control long word, "mcl", control the invocation of
* operations on the hdc.
*
* The hdc operates in queued mode or immediate mode.
* In queued mode, it grabs new mcb's, prioritizes them, and adds
* them to its queue; it knows if we've added any mcb's by checking
* forw_phaddr to see if any are linked off of there.
*
* Bits in the master mcb's status word, "mcs", indicate the status
* of the last-processed mcb. The MCS_ definitions define these bits.
* This word is set to zero when the mcb queue is passed to the hdc
* controller; the hdc controller then sets bits in this word.
* We cannot modify the mcb queue until the hdc has completed an mcb
* (the hdc sets the MCS_Q_DONE bit).
*
* The "context" word is copied from the context word of the completed
* mcb. It is currently the virtual pointer to the completed mcb.
*/
typedef struct {
unsigned long mcl; /* W module control lword (MCL_) */
unsigned long interrupt; /* W interrupt acknowledge word */
unsigned long forw_phaddr; /* W physical address of first mcb */
unsigned long reserve1; /* */
unsigned long reserve2; /* */
unsigned long mcs; /* R status for last completed mcb */
unsigned long cmcb_phaddr; /* W physical addr of completed mcb*/
unsigned long context; /* R software context word */
unsigned long xstatus[HDC_XSTAT_SIZE];/* R xstatus of last mcb */
} master_mcb_type;
/* definition of master mcb "mcl" */
#define MCL_QUEUED 0x00000010 /* start queued execution of mcb's */
#define MCL_IMMEDIATE 0x00000001 /* start immediate xqt of an mcb */
/* definition of master mcb "mcs" */
#define MCS_DONE 0x00000080 /* an mcb is done; status is valid */
#define MCS_FATALERROR 0x00000002 /* a fatal error occurred */
#define MCS_SOFTERROR 0x00000001 /* a recoverable error occurred */
/*
* This structure defines the information returned by the hdc
* controller for a "read drive status" (HCMD_STATUS) command.
* The format of this structure is determined by the hdc firmware.
* r1, r2, etc. are reserved for future use.
*/
typedef struct {
unsigned long drs; /* drive status (see DRS_ below) */
unsigned long r1; /* */
unsigned long r2; /* */
unsigned long r3; /* */
unsigned short max_cyl; /* max logical cylinder address */
unsigned short max_head; /* max logical head address */
unsigned short r4; /* */
unsigned short max_sector; /* max logical sector address */
unsigned short def_cyl; /* definition track cylinder address*/
unsigned short def_cyl_count; /* definition track cylinder count */
unsigned short diag_cyl; /* diagnostic track cylinder address*/
unsigned short diag_cyl_count; /* diagnostic track cylinder count */
unsigned short max_phys_cyl; /* max physical cylinder address */
unsigned short max_phys_head; /* max physical head address */
unsigned short r5; /* */
unsigned short max_phys_sector;/* max physical sector address */
unsigned short r6; /* */
unsigned short id; /* drive id (drive model) */
unsigned short r7; /* */
unsigned short bytes_per_sec; /* bytes/sector -vendorflaw conversn*/
unsigned short r8; /* */
unsigned short rpm; /* disk revolutions per minute */
unsigned long r9; /* */
unsigned long r10; /* */
unsigned long r11; /* */
} drive_stat_type;
/* defines for drive_stat drs word */
#define DRS_FAULT 0x00000080 /* drive is reporting a fault */
#define DRS_RESERVED 0x00000040 /* drive is reserved by other port */
#define DRS_WRITE_PROT 0x00000020 /* drive is write protected */
#define DRS_ON_CYLINDER 0x00000002 /* drive heads are not moving now */
#define DRS_ONLINE 0x00000001 /* drive is available for operation */
/*
* hdc controller table. It contains information specific to each controller.
*/
typedef struct {
int ctlr; /* controller number (0-15) */
hdc_regs_type *registers; /* base address of hdc io registers */
mcb_type *forw_active; /* doubly linked list of */
mcb_type *back_active; /* .. active mcb's */
mcb_type *forw_free; /* doubly linked list of */
mcb_type *back_free; /* .. free mcb's */
mcb_type *forw_wait; /* doubly linked list of */
mcb_type *back_wait; /* .. waiting mcb's */
hdc_mid_type mid; /* the module id is read to here */
long master_phaddr; /* physical address of master mcb */
master_mcb_type master_mcb; /* the master mcb for this hdc */
mcb_type mcbs[HDC_MAXMCBS];/* pool of mcb's for this hdc */
} hdc_ctlr_type;
/*
* hdc unit table. It contains information specific to each hdc drive.
* Some information is obtained from the profile prom and geometry block.
*/
typedef struct {
par_tab partition[GB_MAXPART]; /* partition definitions */
int ctlr; /* the controller number (0-15) */
int slave; /* the slave number (0-4) */
int unit; /* the unit number (0-31) */
int id; /* identifies the disk model */
int spc; /* sectors per cylinder */
int cylinders; /* number of logical cylinders */
int heads; /* number of logical heads */
int sectors; /* number of logical sectors/track */
int phys_cylinders; /* number of physical cylinders */
int phys_heads; /* number of physical heads */
int phys_sectors; /* number of physical sectors/track */
int def_cyl; /* logical cylinder of drive def */
int def_cyl_count; /* number of logical def cylinders */
int diag_cyl; /* logical cylinder of diag area */
int diag_cyl_count; /* number of logical diag cylinders */
int rpm; /* disk rpm */
int bytes_per_sec; /* bytes/sector -vendorflaw conversn*/
int format; /* TRUE= format program is using dsk*/
mcb_type phio_mcb; /* mcb for handler physical io */
struct buf phio_buf; /* buf for handler physical io */
unsigned long phio_data[HDC_PHIO_SIZE]; /* data for physical io */
struct buf raw_buf; /* buf structure for raw i/o */
} hdc_unit_type;
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.