/**
* \file hwdep/hwdep.c
* \brief HwDep Interface (hardware dependent)
* \author Jaroslav Kysela <perex@perex.cz>
* \date 2000-2001
*
* HwDep (hardware dependent) Interface is designed for individual hardware
* access. This interface does not cover any API specification.
*/
/*
* Hardware dependent Interface - main file
* Copyright (c) 2000 by Jaroslav Kysela <perex@perex.cz>
*
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include "hwdep_local.h"
static int snd_hwdep_open_conf(snd_hwdep_t **hwdep,
const char *name, snd_config_t *hwdep_root,
snd_config_t *hwdep_conf, int mode)
{
const char *str;
char buf[256], errbuf[256];
int err;
snd_config_t *conf, *type_conf = NULL;
snd_config_iterator_t i, next;
const char *id;
const char *lib = NULL, *open_name = NULL;
int (*open_func)(snd_hwdep_t **, const char *, snd_config_t *, snd_config_t *, int) = NULL;
#ifndef PIC
extern void *snd_hwdep_open_symbols(void);
#endif
void *h = NULL;
if (snd_config_get_type(hwdep_conf) != SND_CONFIG_TYPE_COMPOUND) {
if (name)
SNDERR("Invalid type for HWDEP %s definition", name);
else
SNDERR("Invalid type for HWDEP definition");
return -EINVAL;
}
err = snd_config_search(hwdep_conf, "type", &conf);
if (err < 0) {
SNDERR("type is not defined");
return err;
}
err = snd_config_get_id(conf, &id);
if (err < 0) {
SNDERR("unable to get id");
return err;
}
err = snd_config_get_string(conf, &str);
if (err < 0) {
SNDERR("Invalid type for %s", id);
return err;
}
err = snd_config_search_definition(hwdep_root, "hwdep_type", str, &type_conf);
if (err >= 0) {
if (snd_config_get_type(type_conf) != SND_CONFIG_TYPE_COMPOUND) {
SNDERR("Invalid type for HWDEP type %s definition", str);
err = -EINVAL;
goto _err;
}
snd_config_for_each(i, next, type_conf) {
snd_config_t *n = snd_config_iterator_entry(i);
const char *id;
if (snd_config_get_id(n, &id) < 0)
continue;
if (strcmp(id, "comment") == 0)
continue;
if (strcmp(id, "lib") == 0) {
err = snd_config_get_string(n, &lib);
if (err < 0) {
SNDERR("Invalid type for %s", id);
goto _err;
}
continue;
}
if (strcmp(id, "open") == 0) {
err = snd_config_get_string(n, &open_name);
if (err < 0) {
SNDERR("Invalid type for %s", id);
goto _err;
}
continue;
}
SNDERR("Unknown field %s", id);
err = -EINVAL;
goto _err;
}
}
if (!open_name) {
open_name = buf;
snprintf(buf, sizeof(buf), "_snd_hwdep_%s_open", str);
}
#ifndef PIC
snd_hwdep_open_symbols();
#endif
h = INTERNAL(snd_dlopen)(lib, RTLD_NOW, errbuf, sizeof(errbuf));
if (h)
open_func = snd_dlsym(h, open_name, SND_DLSYM_VERSION(SND_HWDEP_DLSYM_VERSION));
err = 0;
if (!h) {
SNDERR("Cannot open shared library %s (%s)", lib, errbuf);
err = -ENOENT;
} else if (!open_func) {
SNDERR("symbol %s is not defined inside %s", open_name, lib);
snd_dlclose(h);
err = -ENXIO;
}
_err:
if (type_conf)
snd_config_delete(type_conf);
if (err >= 0) {
err = open_func(hwdep, name, hwdep_root, hwdep_conf, mode);
if (err >= 0) {
(*hwdep)->dl_handle = h;
} else {
snd_dlclose(h);
}
}
return err;
}
static int snd_hwdep_open_noupdate(snd_hwdep_t **hwdep, snd_config_t *root, const char *name, int mode)
{
int err;
snd_config_t *hwdep_conf;
err = snd_config_search_definition(root, "hwdep", name, &hwdep_conf);
if (err < 0) {
SNDERR("Unknown HwDep %s", name);
return err;
}
err = snd_hwdep_open_conf(hwdep, name, root, hwdep_conf, mode);
snd_config_delete(hwdep_conf);
return err;
}
/**
* \brief Opens a new connection to the HwDep interface.
* \param hwdep Returned handle (NULL if not wanted)
* \param name ASCII identifier of the HwDep handle
* \param mode Open mode
* \return 0 on success otherwise a negative error code
*
* Opens a new connection to the HwDep interface specified with
* an ASCII identifier and mode.
*/
int snd_hwdep_open(snd_hwdep_t **hwdep, const char *name, int mode)
{
snd_config_t *top;
int err;
assert(hwdep && name);
err = snd_config_update_ref(&top);
if (err < 0)
return err;
err = snd_hwdep_open_noupdate(hwdep, top, name, mode);
snd_config_unref(top);
return err;
}
/**
* \brief Opens a new connection to the HwDep interface using local configuration
* \param hwdep Returned handle (NULL if not wanted)
* \param name ASCII identifier of the HwDep handle
* \param mode Open mode
* \param lconf The local configuration tree
* \return 0 on success otherwise a negative error code
*
* Opens a new connection to the HwDep interface specified with
* an ASCII identifier and mode.
*/
int snd_hwdep_open_lconf(snd_hwdep_t **hwdep, const char *name,
int mode, snd_config_t *lconf)
{
assert(hwdep && name && lconf);
return snd_hwdep_open_noupdate(hwdep, lconf, name, mode);
}
/**
* \brief close HwDep handle
* \param hwdep HwDep handle
* \return 0 on success otherwise a negative error code
*
* Closes the specified HwDep handle and frees all associated
* resources.
*/
int snd_hwdep_close(snd_hwdep_t *hwdep)
{
int err;
assert(hwdep);
err = hwdep->ops->close(hwdep);
if (hwdep->dl_handle)
snd_dlclose(hwdep->dl_handle);
free(hwdep->name);
free(hwdep);
return err;
}
/**
* \brief get identifier of HwDep handle
* \param hwdep a Hwdep handle
* \return ascii identifier of HwDep handle
*
* Returns the ASCII identifier of given HwDep handle. It's the same
* identifier specified in snd_hwdep_open().
*/
const char *snd_hwdep_name(snd_hwdep_t *hwdep)
{
assert(hwdep);
return hwdep->name;
}
/**
* \brief get type of HwDep handle
* \param hwdep a HwDep handle
* \return type of HwDep handle
*
* Returns the type #snd_hwdep_type_t of given HwDep handle.
*/
snd_hwdep_type_t snd_hwdep_type(snd_hwdep_t *hwdep)
{
assert(hwdep);
return hwdep->type;
}
/**
* \brief get count of poll descriptors for HwDep handle
* \param hwdep HwDep handle
* \return count of poll descriptors
*/
int snd_hwdep_poll_descriptors_count(snd_hwdep_t *hwdep)
{
assert(hwdep);
return 1;
}
/**
* \brief get poll descriptors
* \param hwdep HwDep handle
* \param pfds array of poll descriptors
* \param space space in the poll descriptor array
* \return count of filled descriptors
*/
int snd_hwdep_poll_descriptors(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int space)
{
assert(hwdep);
if (space >= 1) {
pfds->fd = hwdep->poll_fd;
switch (hwdep->mode & O_ACCMODE) {
case O_WRONLY:
pfds->events = POLLOUT|POLLERR|POLLNVAL;
break;
case O_RDONLY:
pfds->events = POLLIN|POLLERR|POLLNVAL;
break;
case O_RDWR:
pfds->events = POLLOUT|POLLIN|POLLERR|POLLNVAL;
break;
default:
return -EIO;
}
return 1;
}
return 0;
}
/**
* \brief get returned events from poll descriptors
* \param hwdep HwDep handle
* \param pfds array of poll descriptors
* \param nfds count of poll descriptors
* \param revents returned events
* \return zero if success, otherwise a negative error code
*/
int snd_hwdep_poll_descriptors_revents(snd_hwdep_t *hwdep, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
{
assert(hwdep && pfds && revents);
if (nfds == 1) {
*revents = pfds->revents;
return 0;
}
return -EINVAL;
}
/**
* \brief set nonblock mode
* \param hwdep HwDep handle
* \param nonblock 0 = block, 1 = nonblock mode
* \return 0 on success otherwise a negative error code
*/
int snd_hwdep_nonblock(snd_hwdep_t *hwdep, int nonblock)
{
int err;
assert(hwdep);
if ((err = hwdep->ops->nonblock(hwdep, nonblock)) < 0)
return err;
if (nonblock)
hwdep->mode |= SND_HWDEP_OPEN_NONBLOCK;
else
hwdep->mode &= ~SND_HWDEP_OPEN_NONBLOCK;
return 0;
}
/**
* \brief get size of the snd_hwdep_info_t structure in bytes
* \return size of the snd_hwdep_info_t structure in bytes
*/
size_t snd_hwdep_info_sizeof()
{
return sizeof(snd_hwdep_info_t);
}
/**
* \brief allocate a new snd_hwdep_info_t structure
* \param info returned pointer
* \return 0 on success otherwise a negative error code if fails
*
* Allocates a new snd_hwdep_info_t structure using the standard
* malloc C library function.
*/
int snd_hwdep_info_malloc(snd_hwdep_info_t **info)
{
assert(info);
*info = calloc(1, sizeof(snd_hwdep_info_t));
if (!*info)
return -ENOMEM;
return 0;
}
/**
* \brief frees the snd_hwdep_info_t structure
* \param info pointer to the snd_hwdep_info_t structure to free
*
* Frees the given snd_hwdep_info_t structure using the standard
* free C library function.
*/
void snd_hwdep_info_free(snd_hwdep_info_t *info)
{
assert(info);
free(info);
}
/**
* \brief copy one snd_hwdep_info_t structure to another
* \param dst destination snd_hwdep_info_t structure
* \param src source snd_hwdep_info_t structure
*/
void snd_hwdep_info_copy(snd_hwdep_info_t *dst, const snd_hwdep_info_t *src)
{
assert(dst && src);
*dst = *src;
}
/**
* \brief get hwdep card number
* \param obj pointer to a snd_hwdep_info_t structure
* \return hwdep card number
*/
int snd_hwdep_info_get_card(const snd_hwdep_info_t *obj)
{
assert(obj);
return obj->card;
}
/**
* \brief get hwdep device number
* \param info pointer to a snd_hwdep_info_t structure
* \return hwdep device number
*/
unsigned int snd_hwdep_info_get_device(const snd_hwdep_info_t *info)
{
assert(info);
return info->device;
}
/**
* \brief get hwdep driver identifier
* \param obj pointer to a snd_hwdep_info_t structure
* \return hwdep driver identifier
*/
const char *snd_hwdep_info_get_id(const snd_hwdep_info_t *obj)
{
assert(obj);
return (const char *)obj->id;
}
/**
* \brief get hwdep driver name
* \param obj pointer to a snd_hwdep_info_t structure
* \return hwdep driver name
*/
const char *snd_hwdep_info_get_name(const snd_hwdep_info_t *obj)
{
assert(obj);
return (const char *)obj->name;
}
/**
* \brief get hwdep protocol interface
* \param obj pointer to a snd_hwdep_info_t structure
* \return hwdep protocol interface
*/
snd_hwdep_iface_t snd_hwdep_info_get_iface(const snd_hwdep_info_t *obj)
{
assert(obj);
return obj->iface;
}
/**
* \brief set hwdep device number
* \param obj pointer to a snd_hwdep_info_t structure
* \param val hwdep device
*/
void snd_hwdep_info_set_device(snd_hwdep_info_t *obj, unsigned int val)
{
assert(obj);
obj->device = val;
}
/**
* \brief get information about HwDep handle
* \param hwdep HwDep handle
* \param info pointer to a snd_hwdep_info_t structure to be filled
* \return 0 on success otherwise a negative error code
*/
int snd_hwdep_info(snd_hwdep_t *hwdep, snd_hwdep_info_t * info)
{
assert(hwdep);
assert(info);
return hwdep->ops->info(hwdep, info);
}
/**
* \brief do hardware dependent ioctl
* \param hwdep HwDep handle
* \param request ioctl command
* \param arg ioctl argument
* \return 0 on success otherwise a negative error code
*/
int snd_hwdep_ioctl(snd_hwdep_t *hwdep, unsigned int request, void * arg)
{
assert(hwdep);
return hwdep->ops->ioctl(hwdep, request, arg);
}
/**
* \brief write bytes using HwDep handle
* \param hwdep HwDep handle
* \param buffer buffer containing bytes to write
* \param size output buffer size in bytes
*/
ssize_t snd_hwdep_write(snd_hwdep_t *hwdep, const void *buffer, size_t size)
{
assert(hwdep);
assert(((hwdep->mode & O_ACCMODE) == O_WRONLY) || ((hwdep->mode & O_ACCMODE) == O_RDWR));
assert(buffer || size == 0);
return hwdep->ops->write(hwdep, buffer, size);
}
/**
* \brief read bytes using HwDep handle
* \param hwdep HwDep handle
* \param buffer buffer to store the input bytes
* \param size input buffer size in bytes
*/
ssize_t snd_hwdep_read(snd_hwdep_t *hwdep, void *buffer, size_t size)
{
assert(hwdep);
assert(((hwdep->mode & O_ACCMODE) == O_RDONLY) || ((hwdep->mode & O_ACCMODE) == O_RDWR));
assert(buffer || size == 0);
return (hwdep->ops->read)(hwdep, buffer, size);
}
/**
* \brief get the DSP status information
* \param hwdep HwDep handle
* \param info pointer to a snd_hwdep_dsp_status_t structure to be filled
* \return 0 on success otherwise a negative error code
*/
int snd_hwdep_dsp_status(snd_hwdep_t *hwdep, snd_hwdep_dsp_status_t *info)
{
assert(hwdep);
assert(info);
return hwdep->ops->ioctl(hwdep, SNDRV_HWDEP_IOCTL_DSP_STATUS, (void*)info);
}
/**
* \brief load the DSP block
* \param hwdep HwDep handle
* \param block pointer to a snd_hwdep_dsp_image_t structure to transfer
* \return 0 on success otherwise a negative error code
*/
int snd_hwdep_dsp_load(snd_hwdep_t *hwdep, snd_hwdep_dsp_image_t *block)
{
assert(hwdep);
assert(block);
return hwdep->ops->ioctl(hwdep, SNDRV_HWDEP_IOCTL_DSP_LOAD, (void*)block);
}
/**
* \brief get size of the snd_hwdep_dsp_status_t structure in bytes
* \return size of the snd_hwdep_dsp_status_t structure in bytes
*/
size_t snd_hwdep_dsp_status_sizeof()
{
return sizeof(snd_hwdep_dsp_status_t);
}
/**
* \brief allocate a new snd_hwdep_dsp_status_t structure
* \param info returned pointer
* \return 0 on success otherwise a negative error code if fails
*
* Allocates a new snd_hwdep_dsp_status_t structure using the standard
* malloc C library function.
*/
int snd_hwdep_dsp_status_malloc(snd_hwdep_dsp_status_t **info)
{
assert(info);
*info = calloc(1, sizeof(snd_hwdep_dsp_status_t));
if (!*info)
return -ENOMEM;
return 0;
}
/**
* \brief frees the snd_hwdep_dsp_status_t structure
* \param info pointer to the snd_hwdep_dsp_status_t structure to free
*
* Frees the given snd_hwdep_dsp_status_t structure using the standard
* free C library function.
*/
void snd_hwdep_dsp_status_free(snd_hwdep_dsp_status_t *info)
{
assert(info);
free(info);
}
/**
* \brief copy one snd_hwdep_dsp_status_t structure to another
* \param dst destination snd_hwdep_dsp_status_t structure
* \param src source snd_hwdep_dsp_status_t structure
*/
void snd_hwdep_dsp_status_copy(snd_hwdep_dsp_status_t *dst, const snd_hwdep_dsp_status_t *src)
{
assert(dst && src);
*dst = *src;
}
/**
* \brief get the driver version of dsp loader
* \param obj pointer to a snd_hwdep_dsp_status_t structure
* \return the driver version
*/
unsigned int snd_hwdep_dsp_status_get_version(const snd_hwdep_dsp_status_t *obj)
{
assert(obj);
return obj->version;
}
/**
* \brief get the driver id of dsp loader
* \param obj pointer to a snd_hwdep_dsp_status_t structure
* \return the driver id string
*/
const char *snd_hwdep_dsp_status_get_id(const snd_hwdep_dsp_status_t *obj)
{
assert(obj);
return (const char *)obj->id;
}
/**
* \brief get number of dsp blocks
* \param obj pointer to a snd_hwdep_dsp_status_t structure
* \return number of dsp blocks
*/
unsigned int snd_hwdep_dsp_status_get_num_dsps(const snd_hwdep_dsp_status_t *obj)
{
assert(obj);
return obj->num_dsps;
}
/**
* \brief get the bit flags of the loaded dsp blocks
* \param info pointer to a snd_hwdep_dsp_status_t structure
* \return the big flags of the loaded dsp blocks
*/
unsigned int snd_hwdep_dsp_status_get_dsp_loaded(const snd_hwdep_dsp_status_t *info)
{
assert(info);
return info->dsp_loaded;
}
/**
* \brief get the chip status of dsp loader
* \param obj pointer to a snd_hwdep_dsp_status_t structure
* \return non-zero if all DSP blocks are loaded and the chip is ready
*/
unsigned int snd_hwdep_dsp_status_get_chip_ready(const snd_hwdep_dsp_status_t *obj)
{
assert(obj);
return obj->chip_ready;
}
/**
* \brief get size of the snd_hwdep_dsp_image_t structure in bytes
* \return size of the snd_hwdep_dsp_image_t structure in bytes
*/
size_t snd_hwdep_dsp_image_sizeof()
{
return sizeof(snd_hwdep_dsp_image_t);
}
/**
* \brief allocate a new snd_hwdep_dsp_image_t structure
* \param info returned pointer
* \return 0 on success otherwise a negative error code if fails
*
* Allocates a new snd_hwdep_dsp_image_t structure using the standard
* malloc C library function.
*/
int snd_hwdep_dsp_image_malloc(snd_hwdep_dsp_image_t **info)
{
assert(info);
*info = calloc(1, sizeof(snd_hwdep_dsp_image_t));
if (!*info)
return -ENOMEM;
return 0;
}
/**
* \brief frees the snd_hwdep_dsp_image_t structure
* \param info pointer to the snd_hwdep_dsp_image_t structure to free
*
* Frees the given snd_hwdep_dsp_image_t structure using the standard
* free C library function.
*/
void snd_hwdep_dsp_image_free(snd_hwdep_dsp_image_t *info)
{
assert(info);
free(info);
}
/**
* \brief copy one snd_hwdep_dsp_image_t structure to another
* \param dst destination snd_hwdep_dsp_image_t structure
* \param src source snd_hwdep_dsp_image_t structure
*/
void snd_hwdep_dsp_image_copy(snd_hwdep_dsp_image_t *dst, const snd_hwdep_dsp_image_t *src)
{
assert(dst && src);
*dst = *src;
}
/**
* \brief get the DSP block index
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \return the index of the DSP block
*/
unsigned int snd_hwdep_dsp_image_get_index(const snd_hwdep_dsp_image_t *obj)
{
assert(obj);
return obj->index;
}
/**
* \brief get the name of the DSP block
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \return the name string of the DSP block
*/
const char *snd_hwdep_dsp_image_get_name(const snd_hwdep_dsp_image_t *obj)
{
assert(obj);
return (const char *)obj->name;
}
/**
* \brief get the length of the DSP block
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \return the length of the DSP block in bytes
*/
size_t snd_hwdep_dsp_image_get_length(const snd_hwdep_dsp_image_t *obj)
{
assert(obj);
return obj->length;
}
/**
* \brief get the image pointer of the DSP block
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \return the image pointer of the DSP block
*/
const void *snd_hwdep_dsp_image_get_image(const snd_hwdep_dsp_image_t *obj)
{
assert(obj);
return obj->image;
}
/**
* \brief set the DSP block index
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \param index the index value to set
*/
void snd_hwdep_dsp_image_set_index(snd_hwdep_dsp_image_t *obj, unsigned int index)
{
assert(obj);
obj->index = index;
}
/**
* \brief set the name of the DSP block
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \param name the name string
*/
void snd_hwdep_dsp_image_set_name(snd_hwdep_dsp_image_t *obj, const char *name)
{
assert(obj && name);
strncpy((char *)obj->name, name, sizeof(obj->name));
obj->name[sizeof(obj->name)-1] = 0;
}
/**
* \brief set the DSP block length
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \param length the length of the DSP block
*/
void snd_hwdep_dsp_image_set_length(snd_hwdep_dsp_image_t *obj, size_t length)
{
assert(obj);
obj->length = length;
}
/**
* \brief set the DSP block image pointer
* \param obj pointer to a snd_hwdep_dsp_image_t structure
* \param image the DSP image pointer
*/
void snd_hwdep_dsp_image_set_image(snd_hwdep_dsp_image_t *obj, void *image)
{
assert(obj);
obj->image = image;
}