Writing Device Drivers

Direct Memory Access (DMA) Functions

Table B-16 Direct Memory Access (DMA) Functions

Function Name	Description
ddi_dma_alloc_handle	allocate a DMA handle
ddi_dma_free_handle	free DMA handle
ddi_dma_mem_alloc	allocate memory for DMA transfer
ddi_dma_mem_free	free previously allocated DMA memory
ddi_dma_addr_bind_handle	bind an address to a DMA handle
ddi_dma_buf_bind_handle	bind a system buffer to a DMA handle
ddi_dma_unbind_handle	unbind the address in a DMA handle
ddi_dma_nextcookie	retrieve subsequent DMA cookie
ddi_dma_getwin	activate a new DMA window
ddi_dma_numwin	retrieve number of DMA windows
ddi_dma_sync	synchronize CPU and I/O views of memory
ddi_check_dma_handle	check DMA handle
ddi_dma_set_sbus64	allow 64-bit transfers on SBus
ddi_slaveonly	tell if a device is installed in a slave access only location
ddi_iomin	find minimum alignment and transfer size for DMA
ddi_dma_burstsizes	find out the allowed burst sizes for a DMA mapping
ddi_dma_devalign	find DMA mapping alignment and minimum transfer size
ddi_dmae_alloc	acquire a DMA channel
ddi_dmae_release	release a DMA channel
ddi_dmae_getattr	get DMA engine attributes
ddi_dmae_prog	program a DMA channel
ddi_dmae_stop	terminate DMA engine operation
ddi_dmae_disable	disable a DMA channel
ddi_dmae_enable	enable a DMA channel
ddi_dmae_getcnt	get DMA engine count remaining
ddi_dmae_1stparty	configure DMA channel cascade mode
ddi_dma_coff	convert a DMA cookie to an offset within a DMA handle

Table B-17 Deprecated Direct Memory Access (DMA) Functions

Deprecated Function	Replacement
ddi_dma_addr_setup	ddi_dma_alloc_handle, ddi_dma_addr_bind_handle
ddi_dma_buf_setup	ddi_dma_alloc_handle, ddi_dma_buf_bind_handle
ddi_dma_curwin	ddi_dma_getwin
ddi_dma_free	ddi_dma_free_handle
ddi_dma_htoc	ddi_dma_addr_bind_handle, ddi_dma_buf_bind_handle
ddi_dma_movwin	ddi_dma_getwin
ddi_dma_nextseg	ddi_dma_nextcookie
ddi_dma_segtocookie	ddi_dma_nextcookie
ddi_dma_setup	ddi_dma_alloc_handle, ddi_dma_addr_bind_handle, ddi_dma_buf_bind_handle
ddi_dmae_getlim	ddi_dmae_getattr
ddi_iopb_alloc	ddi_dma_mem_alloc
ddi_iopb_free	ddi_dma_mem_free
ddi_mem_alloc	ddi_dma_mem_alloc
ddi_mem_free	ddi_dma_mem_free
hat_getkpfnum	ddi_dma_addr_bind_handle, ddi_dma_buf_bind_handle, ddi_dma_nextcookie

Table B-18 User Space Access Functions

Function Name	Description
ddi_copyin	copy data to a driver buffer
ddi_copyout	copy data from a driver
uiomove	copy kernel data using uio structure
ureadc	add character to a uio structure
uwritec	remove a character from a uio structure
ddi_getiminor	get kernel internal minor number from an external dev_t
ddi_model_convert_from	determine data model type mismatch
IOC_CONVERT_FROM	determine if there is a need to translate M_IOCTL contents
STRUCT_DECL	establish handle to application data in possibly differing data model
STRUCT_HANDLE	establish handle to application data in possibly differing data model
STRUCT_INIT	establish handle to application data in possibly differing data model
STRUCT_SET_HANDLE	establish handle to application data in possibly differing data model
SIZEOF_PTR	return size of pointer in specified data model
SIZEOF_STRUCT	return size of structure in specified data model
STRUCT_SIZE	return size of structure in application data model
STRUCT_BUF	return a pointer to the native mode instance of the structure
STRUCT_FADDR	return a pointer to the specified field of a structure
STRUCT_FGET	return specified field of a structure in application data model
STRUCT_FGETP	return specified pointer field of a structure in application data model
STRUCT_FSET	set specified field of a structure in application data model
STRUCT_FSETP	set specified pointer field of a structure in application data model

Table B-19 Deprecated User Space Access Functions

Deprecated Functions	Replacement
copyin	ddi_copyin
copyout	ddi_copyout

Table B-20 User Process Event Functions

Function Name	Description
pollwakeup	inform a process that an event has occurred
proc_ref	get a handle on a process to signal
proc_unref	release a handle on a process to signal
proc_signal	send a signal to a process

Table B-21 User Process Information Functions

Function Name	Description
ddi_get_cred	returns a pointer to the credential structure of the caller
drv_priv	determine process credentials privilege
ddi_get_pid	return the process ID

Table B-22 Deprecated User Process Information Functions

Deprecated Functions	Replacement
drv_getparm	ddi_get_pid, ddi_get_cred

Table B-23 User Application Kernel and Device Access Functions

Function Name	Description
ddi_dev_nregs	return the number of register sets a device has
ddi_dev_regsize	return the size of a device's register
ddi_devmap_segmap	set up a user mapping to device memory
devmap_setup	set up a user mapping to device memory
devmap_devmem_setup	export device memory to user space
devmap_load	control validation of memory address translations
devmap_unload	control validation of memory address translations
devmap_do_ctxmgt	perform device context switching on a mapping
devmap_set_ctx_timeout	set the timeout value for the context management callback
devmap_default_access	default driver memory access function
ddi_umem_alloc	allocate page-aligned kernel memory
ddi_umem_free	free page-aligned kernel memory
ddi_umem_lock	lock memory pages
ddi_umem_unlock	unlock memory pages
ddi_umem_iosetup	setup I/O requests to application memory
devmap_umem_setup	export kernel memory to user space
ddi_model_convert_from	determine data model type mismatch

Table B-24 Deprecated User Application Kernel and Device Access Functions

Deprecated Functions	Replacement
ddi_mapdev	devmap_setup
ddi_mapdev_intercept	devmap_load
ddi_mapdev_nointercept	devmap_unload
ddi_mapdev_set_device_acc_attr	see devmap(9e)
ddi_segmap	see devmap(9e)
ddi_segmap_setup	devmap_setup
hat_getkpfnum	see devmap(9e)
ddi_mmap_get_model	see devmap(9e)


B. Summary of Solaris 9 DDI/DKI Services Introduction Programmed I/O Functions