blob: dab9ea186eb4911361d0da88677718759ab28f82 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Rajeshwari Shinde511ed5f2012-10-25 19:49:22 +00002/*
3 * Copyright (C) 2012 Samsung Electronics
4 * R. Chandrasekar < rcsekar@samsung.com>
Rajeshwari Shinde511ed5f2012-10-25 19:49:22 +00005 */
6
7#ifndef __SOUND_H__
8#define __SOUND_H__
9
10/* sound codec enum */
Rajeshwari Shinde511ed5f2012-10-25 19:49:22 +000011enum sound_compat {
12 AUDIO_COMPAT_SPI,
13 AUDIO_COMPAT_I2C,
14};
15
16/* Codec information structure to store the info from device tree */
17struct sound_codec_info {
18 int i2c_bus;
19 int i2c_dev_addr;
Rajeshwari Shinde511ed5f2012-10-25 19:49:22 +000020};
21
Simon Glassd4901892018-12-10 10:37:36 -070022/**
23 * struct sound_uc_priv - private uclass information about each sound device
24 *
25 * This is used to line the codec and i2s together
26 *
27 * @codec: Codec that is used for this sound device
28 * @i2s: I2S bus that is used for this sound device
29 * @setup_done: true if setup() has been called
30 */
31struct sound_uc_priv {
32 struct udevice *codec;
33 struct udevice *i2s;
34 int setup_done;
35};
36
37/**
Simon Glassa77bf702014-02-27 13:26:20 -070038 * Generates square wave sound data for 1 second
39 *
Simon Glassf9871772018-12-10 10:37:51 -070040 * @sample_rate: Sample rate in Hz
41 * @data: data buffer pointer
42 * @size: size of the buffer in bytes
43 * @freq: frequency of the wave
44 * @channels: Number of channels to use
Simon Glassa77bf702014-02-27 13:26:20 -070045 */
Simon Glass7d92b062018-11-15 19:56:13 -070046void sound_create_square_wave(uint sample_rate, unsigned short *data, int size,
Simon Glassf9871772018-12-10 10:37:51 -070047 uint freq, uint channels);
Simon Glassa77bf702014-02-27 13:26:20 -070048
49/*
Simon Glassd4901892018-12-10 10:37:36 -070050 * The sound uclass brings together a data transport (currently only I2C) and a
51 * codec (currently connected over I2C).
52 */
53
54/* Operations for sound */
55struct sound_ops {
56 /**
Simon Glasse65f9ef2019-02-16 20:24:53 -070057 * setup() - Set up to play a sound (optional)
Simon Glassd4901892018-12-10 10:37:36 -070058 */
59 int (*setup)(struct udevice *dev);
60
61 /**
62 * play() - Play a beep
63 *
64 * @dev: Sound device
65 * @data: Data buffer to play
66 * @data_size: Size of data buffer in bytes
67 * @return 0 if OK, -ve on error
68 */
69 int (*play)(struct udevice *dev, void *data, uint data_size);
Simon Glass28502662019-02-16 20:24:54 -070070
71 /**
Simon Glass3062cd12020-02-03 07:36:06 -070072 * stop_play() - Indicate that there is no more data coming
73 *
74 * This is called once play() has finished sending all the data to the
75 * output device. This may be used to tell the hardware to turn off the
76 * codec, for example.
77 *
78 * @dev: Sound device
79 * @return 0 if OK, -ve on error
80 */
81 int (*stop_play)(struct udevice *dev);
82
83 /**
Simon Glass28502662019-02-16 20:24:54 -070084 * start_beep() - Start beeping (optional)
85 *
86 * This tells the sound hardware to start a beep. It will continue until
87 * stopped by sound_stop_beep().
88 *
89 * @dev: Sound device
90 * @frequency_hz: Beep frequency in hertz
91 * @return if OK, -ENOSYS if not supported, -ve on error
92 */
93 int (*start_beep)(struct udevice *dev, int frequency_hz);
94
95 /**
96 * stop_beep() - Stop beeping (optional)
97 *
98 * This tells the sound hardware to stop a previously started beep.
99 *
100 * @dev: Sound device
101 * @return if OK, -ve on error
102 */
103 int (*stop_beep)(struct udevice *dev);
Simon Glassd4901892018-12-10 10:37:36 -0700104};
105
106#define sound_get_ops(dev) ((struct sound_ops *)(dev)->driver->ops)
107
108/**
109 * setup() - Set up to play a sound
110 */
111int sound_setup(struct udevice *dev);
112
113/**
114 * play() - Play a beep
115 *
116 * @dev: Sound device
117 * @msecs: Duration of beep in milliseconds
118 * @frequency_hz: Frequency of the beep in Hertz
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100119 * Return: 0 if OK, -ve on error
Simon Glassd4901892018-12-10 10:37:36 -0700120 */
121int sound_beep(struct udevice *dev, int msecs, int frequency_hz);
122
123/**
Simon Glass28502662019-02-16 20:24:54 -0700124 * sound_start_beep() - Start beeping
125 *
126 * This tells the sound hardware to start a beep. It will continue until stopped
127 * by sound_stop_beep().
128 *
129 * @dev: Sound device
130 * @frequency_hz: Beep frequency in hertz
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100131 * Return: if OK, -ve on error
Simon Glass28502662019-02-16 20:24:54 -0700132 */
133int sound_start_beep(struct udevice *dev, int frequency_hz);
134
135/**
136 * sound_stop_beep() - Stop beeping
137 *
138 * This tells the sound hardware to stop a previously started beep.
139 *
140 * @dev: Sound device
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100141 * Return: if OK, -ve on error
Simon Glass28502662019-02-16 20:24:54 -0700142 */
143int sound_stop_beep(struct udevice *dev);
144
145/**
Simon Glassd4901892018-12-10 10:37:36 -0700146 * sound_find_codec_i2s() - Called by sound drivers to locate codec and i2s
147 *
148 * This finds the audio codec and i2s devices and puts them in the uclass's
149 * private data for this device.
150 */
151int sound_find_codec_i2s(struct udevice *dev);
152
Rajeshwari Shinde511ed5f2012-10-25 19:49:22 +0000153#endif /* __SOUND__H__ */