1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2016 Alex Teaca <iateaca@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _HDA_EMUL_H_
30#define _HDA_EMUL_H_
31
32#include <stdio.h>
33#include <stdlib.h>
34#include <string.h>
35#include <sys/types.h>
36#include <assert.h>
37
38#include <sys/types.h>
39#include <sys/queue.h>
40#include <sys/kernel.h>
41
42#include "hda_reg.h"
43
44/*
45 * HDA Debug Log
46 */
47#if DEBUG_HDA == 1
48extern FILE *dbg;
49#define DPRINTF(fmt, arg...)						\
50do {fprintf(dbg, "%s-%d: " fmt "\n", __func__, __LINE__, ##arg);		\
51fflush(dbg); } while (0)
52#ifndef DEBUG_HDA_FILE
53#define DEBUG_HDA_FILE "/tmp/bhyve_hda.log"
54#endif
55#else
56#define DPRINTF(fmt, arg...)
57#endif
58
59#define HDA_FIFO_SIZE			0x100
60
61struct hda_softc;
62struct hda_codec_class;
63
64struct hda_codec_inst {
65	uint8_t cad;
66	struct hda_codec_class *codec;
67	struct hda_softc *hda;
68	const struct hda_ops *hops;
69	void *priv;
70};
71
72struct hda_codec_class {
73	const char *name;
74	int (*init)(struct hda_codec_inst *hci, const char *play,
75		const char *rec);
76	int (*reset)(struct hda_codec_inst *hci);
77	int (*command)(struct hda_codec_inst *hci, uint32_t cmd_data);
78	int (*notify)(struct hda_codec_inst *hci, uint8_t run, uint8_t stream,
79		uint8_t dir);
80};
81
82struct hda_ops {
83	int (*signal)(struct hda_codec_inst *hci);
84	int (*response)(struct hda_codec_inst *hci, uint32_t response,
85		uint8_t unsol);
86	int (*transfer)(struct hda_codec_inst *hci, uint8_t stream,
87		uint8_t dir, uint8_t *buf, size_t count);
88};
89
90#define HDA_EMUL_SET(x)		DATA_SET(hda_codec_class_set, x)
91
92#endif	/* _HDA_EMUL_H_ */
93