Index (Writing Device Drivers)

Writing Device Drivers

Previous: Appendix E Hardened Drivers


Numbers and Symbols

	64-bit device drivers ( ) ( )


A

	`add_drv(1M)` command ( )

	address spaces ( )

	`aphysio(9F)` routine ( )

	`aread(9E)` entry point ( )

	`ASSERT(9F)` macro ( )

	associating kernel memory with user applications ( )

	asynchronous communication drivers, testing ( )

	asynchronous data transfers ( )

	`attach(9E)` entry point ( )

	auto-request sense mode ( )

	autoconfiguration
		of block devices ( )
		of character devices ( )
		overview ( )
		routines ( )
		of SCSI devices ( ) ( )

	autoshutdown threshold ( )

	autovectored interrupts ( )

	`awrite(9E)` entry point ( )


B

	binary compatibility ( )

	`biodone(9F)` routine ( )

	block driver
		autoconfiguration of ( )
		`buf(9S)` structure ( )
		`cb_ops(9S)` structure ( )
		overview ( )
		slice number ( )

	block driver entry points ( )
		`close(9E)` ( )
		`open(9E)` ( )
		`strategy(9E)` ( )

	`buf(9S)` structure ( )

	buffer allocation, DMA ( )

	burst sizes, DMA ( )

	bus
		architectures ( )
			ISA ( )
			PCI ( )
			SBus ( )
		SCSI ( )

	bus-master DMA ( ) ( )

	bus nexus device drivers ( )

	byte ordering ( )

	byte-stream I/O ( )


C

	cache, description of ( )

	callback functions ( ) ( )

	`cb_ops(9S)` structure ( )

	character device driver
		`aphysio(9F)` routine ( )
		autoconfiguration of ( )
		`cb_ops(9S)` structure ( )
		`close(9E)` entry point ( )
		data transfers ( )
		device polling ( )
		entry points for ( )
		I/O control mechanism ( )
		memory mapping ( )
		`minphys(9F)` routine ( )
		`open(9E)` entry point ( )
		overview ( )
		`physio(9F)` routine ( )
		`strategy(9E)` entry point ( )

	cloning SCSI HBA driver ( )

	`close(9E)` entry point ( ) ( )

	`cmn_err(9F)` routine ( ) ( ) ( )

	compiling and linking a driver ( )

	condition variables
		and mutex locks ( )
		routines ( )

	`.conf` files ( )

	configuration entry points
		`attach(9E)` ( )
		`detach(9E)` ( )
		`getinfo(9E)` ( )

	configuration files, hardware
		See hardware configuration files

	context management
		See device context management

	context of device driver ( )

	cookies, DMA ( )

	copying data
		`copyin(9F)` routine ( )
		`copyout(9F)` routine ( )

	core dumps, saving ( )

	`cv_` functions
		`cv_destroy(9F)()` ( )
		`cv_init(9F)()` ( )
		`cv_signal(9F)()` ( )
		`cv_timedwait(9F)()` ( )
		`cv_timedwait_sig(9F)()` ( )
		`cv_wait(9F)()` ( )
		`cv_wait_sig(9F)()` ( )


D

	data alignment for SPARC ( )

	data corruption
		detecting ( ) ( )

	data storage classes ( )

	data structures
		`dev_ops(9S)` ( )
		`modldrv(9S)` ( )

	data transfers, character drivers ( )

	DDI, access mechanism ( )

	`ddi_` functions
		`ddi_add_intr(9F)()` ( )
		`ddi_create_minor_node(9F)()` ( )
		`ddi_dev_is_needed(9F)()` ( )
		`ddi_dma_getwin(9F)()` ( )
		`ddi_dma_nextseg(9F)()` ( )
		`ddi_enter_critical(9F)()` ( )
		`ddi_prop_get_int(9F)()` ( )
		`ddi_prop_lookup(9F)()` ( )
		`ddi_prop_op(9F)()` ( )
		`ddi_regs_map_setup(9F)()` ( )
		`ddi_umem_alloc(9F)()` ( )
		`ddi_umem_free(9F)()` ( )

	ddi_check_acc_handle() ( )

	ddi_check_dma_handle() ( )

	DDI-compliant drivers
		byte ordering ( )
		compliance testing ( )

	DDI/DKI
		and disk performance ( )
		overview ( )

	`ddi_dma_attr` structure ( )

	ddi_dma_sync() ( )

	ddi_get() ( )

	`DDI_INFO_DEVT2DEVINFO` ( )

	`DDI_INFO_DEVT2INSTANCE` ( )

	DDI_INTR_UNCLAIMED ( )

	ddi_peek() ( )

	ddi_poke() ( )

	ddi_put() ( )

	ddi_regs_map_setup() ( )

	ddi_rep_get() ( )

	ddi_rep_put() ( )

	`DDI_RESUME` command ( )

	`DDI_SUSPEND` command ( )

	debugging
		`ASSERT(9F)` macro ( )
		booting an alternate kernel ( )
		coding hints ( )
		conditional compilation ( )
		`kadb(1)` ( )
		SCSI target driver ( )
		setting breakpoints ( ) ( )
		setting up a `tip(1)` connection ( )
		tools ( )
		using the SPARC PROM for device debugging ( )

	`detach(9E)` entry point ( )

	`dev_ops(9S)` structure ( )

	`devfsadm(1M)` command ( )

	device, hung ( )

	device access
		system calls ( ) ( )

	device configuration, entry points ( )

	device context management ( )
		entry points ( )
		model ( )
		operation ( )

	device driver
		See also loading drivers
		64-bit drivers
			See also 64-bit device drivers
		64-bit drivers ( ) ( )
		binding to device node ( )
		block driver ( )
		context ( )
		debugging ( )
			coding hints ( )
			setting up a `tip(1)` connection ( )
			tools ( )
			using the PROM ( )
		definition of ( )
		entry points ( )
		error handling ( )
		header files ( )
		instances ( )
		loadable interface ( )
		module configuration ( )
		overview ( )
		packaging ( )
		printing messages ( )
		source files ( )
		standard character driver ( )
		testing ( )
		types of ( )

	device information
		binding a driver to a device ( )
		self-identifying ( )
		tree structure ( ) ( )

	device interrupt handling
		See interrupt handling

	device interrupts
		See interrupts

	device memory
		`D_DEVMAP` `flag in cb_ops(9S)` ( )
		mapping ( ) ( )

	device number ( )

	device polling
		in character drivers ( )
		`chpoll(9E)` entry point ( )
		`poll(2)` system call ( )

	device power management
		components ( )
		definition of ( )
		dependency ( )
		entry points ( )
		interfaces ( )
		model ( )
		power levels ( )
		state transitions ( )

	device power management functions
		`pm_busy_component(9F)()` ( )
		`pm_idle_component(9F)()` ( )
		`power(9E)` ( )

	device registers, mapping ( )

	device state in power management ( )

	device tree ( )

	`devmap_` entry points
		`devmap(9E)` ( )
		`devmap_access(9E)` ( ) ( )
		`devmap_contextmgt(9E)` ( )
		`devmap_dup(9E)` ( )
		`devmap_map(9E)` ( )
		`devmap_unmap(9E)` ( )

	`devmap_` functions
		`devmap_devmem_setup(9F)()` ( )
		`devmap_load(9F)()` ( )
		`devmap_umem_setup(9F)()` ( )
		`devmap_unload(9F)()` ( )

	disk
		I/O controls ( )
		performance ( )

	disk drivers, testing ( )

	DKI
		See DDI/DKI

	DMA ( )
		buffer allocation ( )
		burst sizes ( )
		callbacks ( )
		cookie ( ) ( )
		freeing handle ( )
		freeing resources ( )
		handle ( ) ( ) ( )
		isolating ( )
		object ( )
		object locking ( )
		operations ( )
		physical addresses ( )
		private buffer allocation ( )
		register structure ( )
		resource allocation ( )
		restrictions ( )
		transfers ( ) ( )
		types of ( )
		virtual addresses ( )
		windows ( ) ( )

	driver binding name ( )

	`driver.conf` files ( )

	driver entry points
		`attach(9E)` ( ) ( )
		for block drivers ( )
		for character drivers ( )
		`detach(9E)` ( ) ( )
		`ioctl(9E)` ( )
		`power(9E)` ( )
		`probe(9E)` ( )

	driver module entry points, definition of ( )

	`drv_usecwait(9F)` ( )

	`dump(9E)` entry point ( )

	DVMA
		SBus slots supporting ( )
		virtual addresses ( )

	dynamic memory allocation ( )


E

	entry points
		See also driver entry points
		for block drivers ( )
		for character drivers ( )
		for device power management ( )
		device context management ( )
		for device configuration ( )
		SCSA HBA summary ( )
		for system power management ( )

	error handling ( )

	error messages, printing ( ) ( )

	/etc/system file ( )

	exporting device memory to user applications ( )

	external registers ( )


F

	faults
		containment of ( ) ( )
		detection by hardware ( )

	faulty hardware, alternative strategies for ( )

	file system I/O ( )

	`_fini(9E)` ( ) ( )

	first-party DMA ( ) ( )

	flow of control for power management ( )


G

	`getinfo(9E)` entry point ( )

	graphics devices, device context management of ( )


H

	handle, DMA ( ) ( ) ( )

	hardware configuration files ( ) ( )
		PCI devices ( )
		SBus devices ( )
		SCSI target devices ( )

	hardware context ( )

	hardware state in power management ( )

	HBA driver
		See SCSI HBA driver

	header files for device drivers ( )

	host bus adapter transport layer ( )


I

	I/O
		asynchronous data transfers ( ) ( )
		byte stream ( )
		disk controls ( )
		DMA transfers ( )
		file system structure ( )
		miscellaneous control of ( )
		multiplexing ( )
		programmed transfers ( )
		scatter/gather structures ( )
		synchronous data transfers ( ) ( )

	IA processor
		byte ordering ( )
		data alignment ( )
		floating point operations ( )

	`_info(9E)` ( )

	`_init(9E)` ( ) ( )

	instance numbers ( )

	integrity checks ( )

	internal mode registers ( )

	internal sequencing logic ( )

	interrupt handlers, responsibilities of ( )

	interrupt handling
		`ddi_add_intr(9F)()` ( )
		high-level interrupts ( ) ( ) ( )
		overview ( )
		registering an interrupt handler ( )
		software interrupts ( ) ( )

	interrupt property ( )

	`interrupt` property ( )

	interrupts ( ) ( ) ( )
		common problems with ( )
		description of ( )
		interrupt numbers ( )
		priority levels ( )
		specification ( )
		types of ( )

	`ioctl(9E)` entry point ( )

	IOMMU ( )

	`iovec(9S)` structure ( )

	ISA bus ( )

	isolating DMA ( )


K

	`kadb(1M)` command ( )

	kernel
		resources ( )
		threads ( ) ( )

	kernel, definition of ( )

	kernel memory, associating with user applications ( )

	kernel memory allocation ( )

	kernel modules, directory of ( )

	`kmem_alloc(9F)` ( )


L

	leaf drivers ( )

	linking a driver ( )

	loading drivers
		`add_drv(1M)` command ( )
		compiling a driver ( )
		hardware configuration file ( )
		linking a driver ( )

	loading modules ( ) ( )

	locking primitives, types of ( )

	locks
		mutex ( )
		scheme for ( )

	loops ( ) ( )


M

	M_ERROR ( )

	memory, allocation of ( )

	memory management unit ( )

	memory mapping
		device context management of ( )
		device memory management ( ) ( ) ( )

	memory model
		SPARC ( )
		store buffers ( )

	minor device node ( )

	`minphys(9F)` routine ( )

	`mmap(2)` system call ( )

	`mod_install(9F)` ( )

	`moddebug` kernel variable ( )

	`modldrv(9S)` structure ( )

	`modlinkage(9S)` structure ( )

	module directory ( )

	`modunload(1M)` command ( )

	`mount(2)` system call ( )

	multiplexing I/O ( )

	multiprocessor considerations ( )

	multithreading
		and condition variables ( )
		`D_MP` flag in `cb_ops(9S)` ( )
		and locking primitives ( )
		thread synchronization ( )

	mutex
		functions ( )
		high-level ( )
		locks ( )
		related panics ( )
		routines ( )


N

	network drivers, testing ( )

	node types ( )

	normal interrupts ( )


O

	object locking ( )

	`open(2)` system call ( ) ( )


P

	packaging ( )

	panic ( )

	partial store ordering ( )

	PCI bus ( )
		configuration address space ( )
		configuration base address registers ( )
		hardware configuration files ( )
		I/O address space ( )
		memory address space ( )

	PCI devices ( )

	physical DMA ( )

	`physio(9F)` routine ( )

	PIO ( )

	pointers ( )

	power management
		See also device power management
		See also system power management
		flow of control ( )
		system ( )

	`print(9E)` entry point ( )

	printing messages ( )

	`probe(9E)` entry point ( ) ( )

	process layout ( )

	processor issues
		IA ( )
		SPARC ( ) ( ) ( )

	programmed I/O ( )

	PROM commands ( )

	`prop_op(9E)` ( )

	properties
		`class` property ( )
		`ddi_prop_op(9F)` ( )
		device node name property ( )
		overview ( ) ( )
		`pm-hardware-state` property ( ) ( ) ( )
		`prtconf(1M)` ( )
		`reg` property ( )
		reporting device properties ( )
		SCSI HBA properties ( )
		SCSI target driver ( )
		types of ( ) ( )

	protocol stack ( )

	`prtconf(1M)` ( )

	`prtconf(1M)` ( )

	pseudo device driver ( ) ( )

	putnext ( )


Q

	queuing ( )


R

	`read(9E)` entry point ( )

	readers/writer locks ( )

	received data ( )

	reg property ( )

	register structure, DMA ( )


S

	`S_IFCHR` ( )

	saving core dumps ( )

	SBus
		address bits ( )
		geographical addressing ( )
		hardware configuration files ( )
		physical address space ( )

	SBus slots supporting DVMA ( )

	scatter/gather I/O ( )

	SCSA ( ) ( )
		global data definitions ( )
		HBA transport layer ( )
		interfaces ( )

	SCSI
		architecture ( )
		bus ( )

	scsi_ functions
		scsi_abort(9F) ( )

	`scsi_` functions
		`scsi_alloc_consistent_buf(9F)()` ( )
		`scsi_destroy_pkt(9F)()` ( )
		`scsi_dmafree(9F)()` ( )
		`scsi_free_consistent_buf(9F)()` ( )
		`scsi_ifgetcap(9F)()` ( )
		`scsi_ifsetcap(9F()`) ( )
		`scsi_init_pkt(9F)()` ( )

	scsi_ functions
		scsi_poll(9F) ( )

	`scsi_` functions
		`scsi_probe(9F)()` ( )

	scsi_ functions
		scsi_reset(9F) ( )

	`scsi_` functions
		`scsi_setup_cdb(9F)()` ( )
		`scsi_sync_pkt(9F)()` ( ) ( )
		`scsi_transport(9F)()` ( )
		`scsi_unprobe(9F)()` ( )
		summary list ( )

	`scsi_address(9S)` structure ( )

	`scsi_device(9S)` structure ( ) ( )

	`scsi_hba_` functions
		`scsi_hba_attach_setup(9F)()` ( )
		`scsi_hba_lookup_capstr(9F)()` ( )
		`scsi_hba_pkt_alloc(9F)()` ( )

	`scsi_hba`_ functions, `scsi_hba_pkt_free(9F)()` ( )

	`scsi_hba_` functions
		`scsi_hba_probe(9F)()` ( )
		summary list ( )

	SCSI HBA driver
		abort and reset management ( )
		autoconfiguration ( )
		capability management ( )
		cloning ( )
		command state structure ( )
		command timeout ( )
		command transport ( )
		configuration properties ( )
		data structures ( )
		DMA resources ( )
		driver instance initialization ( )
		entry points summary ( )
		header files ( )
		and hot-plugging ( )
		initializing a transport structure ( )
		installation ( )
		interrupt handling ( )
		module initialization ( )
		overview ( ) ( )
		properties ( )
		resource allocation ( )

	SCSI HBA driver entry points
		by category ( )
		`tran_abort(9E)` ( )
		`tran_dmafree(9E)` ( )
		`tran_getcap(9E)` ( )
		`tran_init_pkt(9E)` ( )
		`tran_reset(9E)` ( )
		`tran_reset_notify(9E)` ( )
		`tran_setcap(9E)` ( )
		`tran_start(9E)` ( )
		`tran_sync_pkt(9E)` ( )
		`tran_tgt_free(9E)` ( )
		`tran_tgt_init(9E)` ( )
		`tran_tgt_probe(9E)` ( )

	`scsi_hba_tran(9S)` structure ( ) ( )

	`scsi_pkt(9S)` structure ( ) ( )

	SCSI target driver
		auto-request sense mode ( )
		autoconfiguration of ( )
		building a command ( )
		callback routine ( )
		data structures ( )
		debugging ( )
		initializing a command descriptor block ( )
		overview ( )
		properties ( ) ( ) ( )
		resource allocation ( )
		reusing packets ( )
		SCSI routines ( )
		transporting a command ( )

	`segmap(9E)` entry point ( ) ( )

	self-identifying devices ( )

	slice number for block devices ( )

	soft interrupts ( )

	source compatibility ( )

	source files for device drivers ( )

	SPARC processor
		byte ordering ( )
		data alignment ( )
		floating point operations ( )
		multiply and divide instructions ( )
		register windows ( )
		structure member alignment ( )

	special files ( )

	state structure ( ) ( )

	store buffers ( )

	`strategy(9E)` entry point
		block drivers ( )
		character drivers ( )

	streams ( ) ( )

	STREAMS
		`cb_ops(9S)` structure ( )
		drivers ( )

	SYNC_FOR_DEV ( )

	synchronous data transfers ( )

	system call, description of ( )

	system integrity ( )

	system power management ( )
		entry points ( )
		model ( )
		policy ( )
		saving hardware state ( )


T

	tagged queuing ( )

	tape drivers, testing ( )

	testing ( )
		asynchronous communication drivers ( )
		configuration ( )
		DDI compliance ( )
		disk drivers ( )
		functionality ( )
		installation and packaging ( )
		network drivers ( )
		tape drivers ( )

	third-party DMA ( ) ( )

	thread synchronization
		condition variables ( )
		`mutex_init(9F)` ( )
		mutex locks ( )
		per instance mutex ( )
		readers/writer locks ( )

	threads, pre-emption of ( )

	`tip(1)` connection ( )

	total store ordering ( )

	`tran_abort(9E)` entry point ( )

	`tran_destroy_pkt(9E)` entry point ( )

	`tran_dmafree(9E)` entry point ( )

	`tran_getcap(9E)` entry point ( )

	`tran_init_pkt(9E)` entry point ( )

	`tran_reset(9E)` entry point ( )

	`tran_reset_notify(9E)` entry point ( )

	`tran_setcap(9E)` entry point ( )

	`tran_start(9E)` entry point ( )

	`tran_sync_pkt(9E)` entry point ( )


U

	`uio(9S)` data structure ( )

	`uiomove(9F)` routine ( )

	unloading drivers ( )

	untagged queuing ( )


V

	vectored I/O ( )

	virtual addresses ( )

	virtual DMA ( )

	virtual memory, memory management unit (MMU) ( )

	virtual memory address spaces ( )


W

	windows, DMA ( )

	wput ( ) ( )

	`write(2)` system call ( )

	`write(9E)` entry point ( )

Previous: Appendix E Hardened Drivers