HelenOS sources

root/uspace/drv/audio/sb16/dsp.h

INCLUDED FROM

/*
 * Copyright (c) 2025 Jiri Svoboda
 * Copyright (c) 2011 Jan Vesely
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/** @addtogroup drvaudiosb16
 * @{
 */
/** @file
 * @brief Sound Blaster Digital Sound Processor (DSP) helper functions.
 */
#ifndef DRV_AUDIO_SB16_DSP_H
#define DRV_AUDIO_SB16_DSP_H

#include <ddf/driver.h>
#include <libarch/ddi.h>
#include <errno.h>
#include <pcm/sample_format.h>
#include <audio_pcm_iface.h>

#include "registers.h"
typedef enum {
        DSP_PLAYBACK_ACTIVE_EVENTS,
        DSP_CAPTURE_ACTIVE_EVENTS,
        DSP_PLAYBACK_NOEVENTS,
        DSP_CAPTURE_NOEVENTS,
        DSP_PLAYBACK_TERMINATE,
        DSP_CAPTURE_TERMINATE,
        DSP_READY,
        DSP_NO_BUFFER,
        DSP_QUIESCED
} dsp_state_t;

typedef struct sb_dsp {
        sb16_regs_t *regs;
        int dma8_channel;
        int dma16_channel;
        struct {
                uint8_t major;
                uint8_t minor;
        } version;
        struct {
                uint8_t *data;
                size_t size;
        } buffer;
        struct {
                uint8_t mode;
                uint16_t samples;
                unsigned frame_count;
        } active;
        dsp_state_t state;
        async_sess_t *event_session;
        async_exch_t *event_exchange;
        ddf_dev_t *sb_dev;
} sb_dsp_t;

errno_t sb_dsp_init(sb_dsp_t *dsp, sb16_regs_t *regs, ddf_dev_t *dev,
    int dma8, int dma16);
void sb_dsp_quiesce(sb_dsp_t *dsp);
void sb_dsp_interrupt(sb_dsp_t *dsp);
unsigned sb_dsp_query_cap(sb_dsp_t *dsp, audio_cap_t cap);
errno_t sb_dsp_get_buffer_position(sb_dsp_t *dsp, size_t *size);
errno_t sb_dsp_test_format(sb_dsp_t *dsp, unsigned *channels, unsigned *rate,
    pcm_sample_format_t *format);
errno_t sb_dsp_get_buffer(sb_dsp_t *dsp, void **buffer, size_t *size);
errno_t sb_dsp_set_event_session(sb_dsp_t *dsp, async_sess_t *session);
async_sess_t *sb_dsp_get_event_session(sb_dsp_t *dsp);
errno_t sb_dsp_release_buffer(sb_dsp_t *dsp);
errno_t sb_dsp_start_playback(sb_dsp_t *dsp, unsigned frames,
    unsigned channels, unsigned sample_rate, pcm_sample_format_t format);
errno_t sb_dsp_stop_playback(sb_dsp_t *dsp, bool immediate);
errno_t sb_dsp_start_capture(sb_dsp_t *dsp, unsigned frames,
    unsigned channels, unsigned sample_rate, pcm_sample_format_t format);
errno_t sb_dsp_stop_capture(sb_dsp_t *dsp, bool immediate);

#endif
/**
 * @}
 */