API Reference

This chapter describes the API data types and functions in alphabetical order. (The ado prefix to these names stands for audio.)

ado_attach_interrupt()
Attach a handler function to an interrupt
ado_calloc()
Allocate space for an array
ado_card_set_longname()
Create a name that identifies an instance of the audio hardware
ado_card_set_shortname()
Create a name that identifies the type of the audio hardware
ado_debug()
Send a debugging string to slogger for logging
ado_device_mmap()
Map a region of physical memory
ado_device_munmap()
Release a virtual memory region
ado_error()
Send an error string to slogger for logging
ado_free()
Deallocate a block of memory
ado_malloc()
Allocate memory
ado_memory_dump()
Show all memory currently in use by the ado_* family of allocation functions
ado_mixer_capture_group_create()
Create a capture group
ado_mixer_create()
Allocate a new mixer structure, then attach it
ado_mixer_dll()
Load the specified standard mixer DLL
ado_mixer_element_accu1()
Create an accumulator (type 1) element
ado_mixer_element_accu2()
Create an accumulator (type 2) element
ado_mixer_element_accu3()
Create an accumulator (type 3) element
ado_mixer_element_io()
Create an input/output element
ado_mixer_element_mux1()
Create a multiplexer (type 1) element
ado_mixer_element_mux2()
Create a multiplexer (type 2) element
ado_mixer_element_notify()
Notify the upper driver levels that there's been a change in an element
ado_mixer_element_pcm1()
Create a PCM (type 1) element
ado_mixer_element_pcm2()
Create a PCM (type 2) element
ado_mixer_element_route_add()
Indicate an ordered relationship between two mixer elements
ado_mixer_element_sw1()
Create a switch (type 1) element
ado_mixer_element_sw2()
Create a switch (type 2) element
ado_mixer_element_sw3()
Create a switch (type 3) element
ado_mixer_element_vol_range_max()
Read the maximum volume setting of the mixer volume element
ado_mixer_element_vol_range_min()
Read the minimum volume setting of the mixer volume element
ado_mixer_element_volume1()
Create a volume (type 1) element
ado_mixer_find_element()
Search a mixer for an element
ado_mixer_find_group()
Search a mixer for a group
ado_mixer_get_context()
Get a pointer to a mixer's context structure
ado_mixer_get_element_instance_data()
Access a mixer element's instance data
ado_mixer_lock()
Limit access to the mixer
ado_mixer_playback_group_create()
Create a playback group
ado_mixer_set_destroy_func()
Attach a function to the mixer to be called when the mixer is destroyed
ado_mixer_set_name()
Attach the character string name to the mixer
ado_mixer_set_reset_func()
Attach a function to the mixer to be called when a hardware reset of the mixer occurs
ado_mixer_switch_new()
Create a new mixer switch
ado_mixer_unlock()
Unlock the attribute structure
ado_mutex_destroy()
Destroy a mutex
ado_mutex_init()
Initialize a mutex
ado_mutex_lock()
Lock a mutex
ado_mutex_unlock()
Unlock a mutex
ado_pci
Data structure that describes a selected PCI card
ado_pci_device()
Try to connect to a specified PCI card
ado_pci_release()
Detach from a given PCI card
ado_pcm_cap_t
Data structure of capabilities of a PCM device
ado_pcm_config_t
Data structure that describes the configuration of a PCM subchannel
ado_pcm_chn_mixer()
Logically associate a mixer element and group with a PCM device
ado_pcm_create()
Create a PCM audio device
ado_pcm_dma_int_size()
Obtain the fragment size of a PCM channel
ado_pcm_format_bit_width()
Obtain the sample width, in bits, for a given format
ado_pcm_hw_t
Data structure of callbacks for PCM devices
ado_pcm_subchn_caps()
Get a pointer to the capabilities structure for a subchannel
ado_pcm_subchn_is_channel()
Check if a channel is a subchannel of a PCM device
ado_pcm_subchn_mixer()
Logically associate a mixer element and group with a PCM subchannel device
ado_pcm_subchn_mixer_create()
Create a PCM subchannel mixer
ado_pcm_subchn_mixer_destroy()
Destroy a PCM subchannel mixer
ado_pcm_sw_mix()
Provide a mechanism for an audio chip to support multiple simultaneous streams
ado_realloc()
Allocate, reallocate, or free a block of memory
ado_rwlock_destroy()
Destroy a read-write lock
ado_rwlock_init()
Initialize a read-write lock
ado_rwlock_rdlock()
Acquire a shared read lock on a read-write lock
ado_rwlock_unlock()
Unlock a read-write lock
ado_rwlock_wrlock()
Acquire an exclusive write lock on a read-write lock
ado_shm_alloc()
Allocate shared memory
ado_shm_free()
Release memory and unlink shared memory
ado_shm_mmap()
Map a shared memory region into the Audio HW DLL's address space
ado_strdup()
Create a duplicate of a string
dma_interrupt()
Signal the upper layers of a driver that the current fragment of a subchannel has been completed by the DMA engine