Digital TV (DVB) devices

struct dvb_ca_en50221 — Structure describing a CA interface
dvb_ca_en50221_camchange_irq — A CAMCHANGE IRQ has occurred.
dvb_ca_en50221_camready_irq — A CAMREADY IRQ has occurred.
dvb_ca_en50221_frda_irq — An FR or a DA IRQ has occurred.
dvb_ca_en50221_init — Initialise a new DVB CA device.
dvb_ca_en50221_release — Release a DVB CA device.
struct dvb_frontend_tune_settings — parameters to adjust frontend tuning
struct dvb_tuner_info — Frontend name and min/max ranges/bandwidths
struct analog_parameters — Parameters to tune into an analog/radio channel
enum dvbfe_algo — defines the algorithm used to tune into a channel
enum dvbfe_search — search callback possible return status
struct dvb_tuner_ops — Tuner information and callbacks
struct analog_demod_info — Information struct for analog TV part of the demod
struct analog_demod_ops — Demodulation information and callbacks for analog TV and radio
struct dvb_frontend_ops — Demodulation information and callbacks for ditialt TV
struct dtv_frontend_properties — contains a list of properties that are specific to a digital TV standard.
struct dvb_frontend — Frontend structure to be used on drivers.
intlog2 — computes log2 of a value; the result is shifted left by 24 bits
intlog10 — computes log10 of a value; the result is shifted left by 24 bits
dvb_ringbuffer_pkt_write — Write a packet into the ringbuffer.
dvb_ringbuffer_pkt_read_user — Read from a packet in the ringbuffer.
dvb_ringbuffer_pkt_read — Read from a packet in the ringbuffer.
dvb_ringbuffer_pkt_dispose — Dispose of a packet in the ring buffer.
dvb_ringbuffer_pkt_next — Get the index of the next packet in a ringbuffer.
struct dvb_adapter — represents a Digital TV adapter using Linux DVB API
struct dvb_device — represents a DVB device node
dvb_register_adapter — Registers a new DVB adapter
dvb_unregister_adapter — Unregisters a DVB adapter
dvb_register_device — Registers a new DVB device
dvb_unregister_device — Unregisters a DVB device
Digital TV Demux API
Demux Callback API
enum ts_filter_type — filter type bitmap for dmx_ts_feed.set
struct dmx_ts_feed — Structure that contains a TS feed filter
struct dmx_section_filter — Structure that describes a section filter
struct dmx_section_feed — Structure that contains a section feed filter
dmx_ts_cb — DVB demux TS filter callback function prototype
dmx_section_cb — DVB demux TS filter callback function prototype
enum dmx_frontend_source — Used to identify the type of frontend
struct dmx_frontend — Structure that lists the frontends associated with a demux
enum dmx_demux_caps — MPEG-2 TS Demux capabilities bitmap
struct dmx_demux — Structure that contains the demux capabilities and callbacks.

Digital TV Demux API

The kernel demux API defines a driver-internal interface for registering low-level, hardware specific driver to a hardware independent demux layer. It is only of interest for Digital TV device driver writers. The header file for this API is named demux.h and located in drivers/media/dvb-core.

The demux API should be implemented for each demux in the system. It is used to select the TS source of a demux and to manage the demux resources. When the demux client allocates a resource via the demux API, it receives a pointer to the API of that resource.

Each demux receives its TS input from a DVB front-end or from memory, as set via this demux API. In a system with more than one front-end, the API can be used to select one of the DVB front-ends as a TS source for a demux, unless this is fixed in the HW platform. The demux API only controls front-ends regarding to their connections with demuxes; the APIs used to set the other front-end parameters, such as tuning, are not defined in this document.

The functions that implement the abstract interface demux should be defined static or module private and registered to the Demux core for external access. It is not necessary to implement every function in the struct dmx_demux. For example, a demux interface might support Section filtering, but not PES filtering. The API client is expected to check the value of any function pointer before calling the function: the value of NULL means that the “function is not available”.

Whenever the functions of the demux API modify shared data, the possibilities of lost update and race condition problems should be addressed, e.g. by protecting parts of code with mutexes.

Note that functions called from a bottom half context must not sleep. Even a simple memory allocation without using GFP_ATOMIC can result in a kernel thread being put to sleep if swapping is needed. For example, the Linux kernel calls the functions of a network device interface from a bottom half context. Thus, if a demux API function is called from network device code, the function must not sleep.

Demux Callback API

This kernel-space API comprises the callback functions that deliver filtered data to the demux client. Unlike the other DVB kABIs, these functions are provided by the client and called from the demux code.

The function pointers of this abstract interface are not packed into a structure as in the other demux APIs, because the callback functions are registered and used independent of each other. As an example, it is possible for the API client to provide several callback functions for receiving TS packets and no callbacks for PES packets or sections.

The functions that implement the callback API need not be re-entrant: when a demux driver calls one of these functions, the driver is not allowed to call the function again before the original call returns. If a callback is triggered by a hardware interrupt, it is recommended to use the Linux “bottom half” mechanism or start a tasklet instead of making the callback function call directly from a hardware interrupt.

This mechanism is implemented by dmx_ts_cb() and dmx_section_cb().