source: mainline/uspace/drv/audio/hdaudio/pcm_iface.c

/*
 * Copyright (c) 2022 Jiri Svoboda
 * 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 hdaudio
 * @{
 */
/** @file High Definition Audio PCM interface
 */

#include <async.h>
#include <audio_pcm_iface.h>
#include <ddf/log.h>
#include <errno.h>
#include <pcm/sample_format.h>
#include <stdbool.h>

#include "codec.h"
#include "hdactl.h"
#include "hdaudio.h"
#include "pcm_iface.h"
#include "spec/fmt.h"
#include "stream.h"

static errno_t hda_get_info_str(ddf_fun_t *, const char **);
static unsigned hda_query_cap(ddf_fun_t *, audio_cap_t);
static errno_t hda_test_format(ddf_fun_t *, unsigned *, unsigned *,
    pcm_sample_format_t *);
static errno_t hda_get_buffer(ddf_fun_t *, void **, size_t *);
static errno_t hda_get_buffer_position(ddf_fun_t *, size_t *);
static errno_t hda_set_event_session(ddf_fun_t *, async_sess_t *);
static async_sess_t *hda_get_event_session(ddf_fun_t *);
static errno_t hda_release_buffer(ddf_fun_t *);
static errno_t hda_start_playback(ddf_fun_t *, unsigned, unsigned, unsigned,
    pcm_sample_format_t);
static errno_t hda_stop_playback(ddf_fun_t *, bool);
static errno_t hda_start_capture(ddf_fun_t *, unsigned, unsigned, unsigned,
    pcm_sample_format_t);
static errno_t hda_stop_capture(ddf_fun_t *, bool);

audio_pcm_iface_t hda_pcm_iface = {
        .get_info_str = hda_get_info_str,
        .test_format = hda_test_format,
        .query_cap = hda_query_cap,

        .get_buffer = hda_get_buffer,
        .release_buffer = hda_release_buffer,
        .set_event_session = hda_set_event_session,
        .get_event_session = hda_get_event_session,
        .get_buffer_pos = hda_get_buffer_position,

        .start_playback = hda_start_playback,
        .stop_playback = hda_stop_playback,

        .start_capture = hda_start_capture,
        .stop_capture = hda_stop_capture
};

enum {
        max_buffer_size = 65536 /* XXX this is completely arbitrary */
};

static hda_t *fun_to_hda(ddf_fun_t *fun)
{
        return (hda_t *)ddf_dev_data_get(ddf_fun_get_dev(fun));
}

static errno_t hda_get_info_str(ddf_fun_t *fun, const char **name)
{
        ddf_msg(LVL_DEBUG, "hda_get_info_str()");
        if (name)
                *name = "High Definition Audio";
        return EOK;
}

static unsigned hda_query_cap(ddf_fun_t *fun, audio_cap_t cap)
{
        hda_t *hda = fun_to_hda(fun);

        ddf_msg(LVL_DEBUG, "hda_query_cap(%d)", cap);
        switch (cap) {
        case AUDIO_CAP_PLAYBACK:
        case AUDIO_CAP_INTERRUPT:
                /* XXX Only if we have an output converter */
                return 1;
        case AUDIO_CAP_CAPTURE:
                /* Yes if we have an input converter */
                return hda->ctl->codec->in_aw >= 0;
        case AUDIO_CAP_BUFFER_POS:
                return 0;
        case AUDIO_CAP_MAX_BUFFER:
                return max_buffer_size;
        case AUDIO_CAP_INTERRUPT_MIN_FRAMES:
                return 128;
        case AUDIO_CAP_INTERRUPT_MAX_FRAMES:
                return 16384;
        default:
                return -1;
        }
}

static errno_t hda_test_format(ddf_fun_t *fun, unsigned *channels,
    unsigned *rate, pcm_sample_format_t *format)
{
        errno_t rc = EOK;

        ddf_msg(LVL_DEBUG, "hda_test_format(%u, %u, %d)\n",
            *channels, *rate, *format);

        if (*channels != 2) {
                *channels = 2;
                rc = ELIMIT;
        }

        if (*format != PCM_SAMPLE_SINT16_LE) {
                *format = PCM_SAMPLE_SINT16_LE;
                rc = ELIMIT;
        }

        if (*rate != 44100) {
                *rate = 44100;
                rc = ELIMIT;
        }

        return rc;
}

static errno_t hda_get_buffer(ddf_fun_t *fun, void **buffer, size_t *size)
{
        hda_t *hda = fun_to_hda(fun);
        errno_t rc;

        hda_lock(hda);

        ddf_msg(LVL_DEBUG, "hda_get_buffer(): hda=%p", hda);
        if (hda->pcm_buffers != NULL) {
                hda_unlock(hda);
                return EBUSY;
        }

        ddf_msg(LVL_DEBUG, "hda_get_buffer() - allocate stream buffers");
        rc = hda_stream_buffers_alloc(hda, &hda->pcm_buffers);
        if (rc != EOK) {
                assert(rc == ENOMEM);
                hda_unlock(hda);
                return ENOMEM;
        }

        ddf_msg(LVL_DEBUG, "hda_get_buffer() - fill info");
        /* XXX This is only one buffer */
        *buffer = hda->pcm_buffers->buf[0];
        *size = hda->pcm_buffers->bufsize * hda->pcm_buffers->nbuffers;

        ddf_msg(LVL_DEBUG, "hda_get_buffer() returing EOK, buffer=%p, size=%zu",
            *buffer, *size);

        hda_unlock(hda);
        return EOK;
}

static errno_t hda_get_buffer_position(ddf_fun_t *fun, size_t *pos)
{
        ddf_msg(LVL_DEBUG, "hda_get_buffer_position()");
        return ENOTSUP;
}

static errno_t hda_set_event_session(ddf_fun_t *fun, async_sess_t *sess)
{
        hda_t *hda = fun_to_hda(fun);

        ddf_msg(LVL_DEBUG, "hda_set_event_session()");
        hda_lock(hda);
        hda->ev_sess = sess;
        hda_unlock(hda);

        return EOK;
}

static async_sess_t *hda_get_event_session(ddf_fun_t *fun)
{
        hda_t *hda = fun_to_hda(fun);
        async_sess_t *sess;

        ddf_msg(LVL_DEBUG, "hda_get_event_session()");

        hda_lock(hda);
        sess = hda->ev_sess;
        hda_unlock(hda);

        return sess;
}

static errno_t hda_release_buffer(ddf_fun_t *fun)
{
        hda_t *hda = fun_to_hda(fun);

        hda_lock(hda);

        ddf_msg(LVL_DEBUG, "hda_release_buffer()");
        if (hda->pcm_buffers == NULL) {
                hda_unlock(hda);
                return EINVAL;
        }

        hda_stream_buffers_free(hda->pcm_buffers);
        hda->pcm_buffers = NULL;

        hda_unlock(hda);
        return EOK;
}

static errno_t hda_start_playback(ddf_fun_t *fun, unsigned frames,
    unsigned channels, unsigned rate, pcm_sample_format_t format)
{
        hda_t *hda = fun_to_hda(fun);
        errno_t rc;

        ddf_msg(LVL_DEBUG, "hda_start_playback()");
        hda_lock(hda);

        if (hda->pcm_stream != NULL) {
                hda_unlock(hda);
                return EBUSY;
        }

        /* XXX Choose appropriate parameters */
        uint32_t fmt;
        /* 48 kHz, 16-bits, 1 channel */
        fmt = (fmt_base_44khz << fmt_base) | (fmt_bits_16 << fmt_bits_l) | 1;

        ddf_msg(LVL_NOTE, "hda_start_playback() - create output stream");
        hda->pcm_stream = hda_stream_create(hda, sdir_output, hda->pcm_buffers,
            fmt);
        if (hda->pcm_stream == NULL) {
                hda_unlock(hda);
                return EIO;
        }

        rc = hda_out_converter_setup(hda->ctl->codec, hda->pcm_stream);
        if (rc != EOK) {
                hda_stream_destroy(hda->pcm_stream);
                hda->pcm_stream = NULL;
                hda_unlock(hda);
                return rc;
        }

        hda->playing = true;
        hda_stream_start(hda->pcm_stream);
        hda_unlock(hda);
        return EOK;
}

static errno_t hda_stop_playback(ddf_fun_t *fun, bool immediate)
{
        hda_t *hda = fun_to_hda(fun);

        ddf_msg(LVL_DEBUG, "hda_stop_playback()");
        hda_lock(hda);
        hda_stream_stop(hda->pcm_stream);
        hda_stream_reset(hda->pcm_stream);
        hda->playing = false;
        hda_stream_destroy(hda->pcm_stream);
        hda->pcm_stream = NULL;

        hda_unlock(hda);

        hda_pcm_event(hda, PCM_EVENT_PLAYBACK_TERMINATED);
        return EOK;
}

static errno_t hda_start_capture(ddf_fun_t *fun, unsigned frames, unsigned channels,
    unsigned rate, pcm_sample_format_t format)
{
        hda_t *hda = fun_to_hda(fun);
        errno_t rc;

        ddf_msg(LVL_DEBUG, "hda_start_capture()");
        hda_lock(hda);

        if (hda->pcm_stream != NULL) {
                hda_unlock(hda);
                return EBUSY;
        }

        /* XXX Choose appropriate parameters */
        uint32_t fmt;
        /* 48 kHz, 16-bits, 1 channel */
        fmt = (fmt_base_44khz << fmt_base) | (fmt_bits_16 << fmt_bits_l) | 1;

        ddf_msg(LVL_DEBUG, "hda_start_capture() - create input stream");
        hda->pcm_stream = hda_stream_create(hda, sdir_input, hda->pcm_buffers,
            fmt);
        if (hda->pcm_stream == NULL) {
                hda_unlock(hda);
                return EIO;
        }

        rc = hda_in_converter_setup(hda->ctl->codec, hda->pcm_stream);
        if (rc != EOK) {
                hda_stream_destroy(hda->pcm_stream);
                hda->pcm_stream = NULL;
                hda_unlock(hda);
                return rc;
        }

        hda->capturing = true;
        hda_stream_start(hda->pcm_stream);
        hda_unlock(hda);
        return EOK;
}

static errno_t hda_stop_capture(ddf_fun_t *fun, bool immediate)
{
        hda_t *hda = fun_to_hda(fun);

        ddf_msg(LVL_DEBUG, "hda_stop_capture()");
        hda_lock(hda);
        hda_stream_stop(hda->pcm_stream);
        hda_stream_reset(hda->pcm_stream);
        hda->capturing = false;
        hda_stream_destroy(hda->pcm_stream);
        hda->pcm_stream = NULL;
        hda_unlock(hda);

        hda_pcm_event(hda, PCM_EVENT_CAPTURE_TERMINATED);
        return EOK;
}

void hda_pcm_event(hda_t *hda, pcm_event_t event)
{
        async_exch_t *exchange;

        if (hda->ev_sess == NULL) {
                if (0)
                        ddf_log_warning("No one listening for event %u", event);
                return;
        }

        exchange = async_exchange_begin(hda->ev_sess);
        async_msg_1(exchange, event, 0);
        async_exchange_end(exchange);
}

/** @}
 */