X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=include%2Fsound.h;h=47de9fa3ed3ac70245cbedac9f811d2410009c31;hb=24b77393a5fcc3e1f51b4e3a1080c0efb60b52eb;hp=a06ab853869faef2137c18e290c2c0308bd625c7;hpb=c2120fbfbc4d1f6953228f86be8bdbf38bacfdab;p=oweals%2Fu-boot.git diff --git a/include/sound.h b/include/sound.h index a06ab85386..47de9fa3ed 100644 --- a/include/sound.h +++ b/include/sound.h @@ -1,21 +1,12 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ /* * Copyright (C) 2012 Samsung Electronics * R. Chandrasekar < rcsekar@samsung.com> - * - * SPDX-License-Identifier: GPL-2.0+ */ #ifndef __SOUND_H__ #define __SOUND_H__ -/* sound codec enum */ -enum en_sound_codec { - CODEC_WM_8994, - CODEC_WM_8995, - CODEC_MAX_98095, - CODEC_MAX -}; - /* sound codec enum */ enum sound_compat { AUDIO_COMPAT_SPI, @@ -26,22 +17,125 @@ enum sound_compat { struct sound_codec_info { int i2c_bus; int i2c_dev_addr; - enum en_sound_codec codec_type; }; -/* - * Initialises audio sub system - * @param blob Pointer of device tree node or NULL if none. - * @return int value 0 for success, -1 for error +/** + * struct sound_uc_priv - private uclass information about each sound device + * + * This is used to line the codec and i2s together + * + * @codec: Codec that is used for this sound device + * @i2s: I2S bus that is used for this sound device + * @setup_done: true if setup() has been called + */ +struct sound_uc_priv { + struct udevice *codec; + struct udevice *i2s; + int setup_done; +}; + +/** + * Generates square wave sound data for 1 second + * + * @sample_rate: Sample rate in Hz + * @data: data buffer pointer + * @size: size of the buffer in bytes + * @freq: frequency of the wave + * @channels: Number of channels to use */ -int sound_init(const void *blob); +void sound_create_square_wave(uint sample_rate, unsigned short *data, int size, + uint freq, uint channels); /* - * plays the pcm data buffer in pcm_data.h through i2s1 to make the - * sine wave sound + * The sound uclass brings together a data transport (currently only I2C) and a + * codec (currently connected over I2C). + */ + +/* Operations for sound */ +struct sound_ops { + /** + * setup() - Set up to play a sound (optional) + */ + int (*setup)(struct udevice *dev); + + /** + * play() - Play a beep + * + * @dev: Sound device + * @data: Data buffer to play + * @data_size: Size of data buffer in bytes + * @return 0 if OK, -ve on error + */ + int (*play)(struct udevice *dev, void *data, uint data_size); + + /** + * start_beep() - Start beeping (optional) + * + * This tells the sound hardware to start a beep. It will continue until + * stopped by sound_stop_beep(). + * + * @dev: Sound device + * @frequency_hz: Beep frequency in hertz + * @return if OK, -ENOSYS if not supported, -ve on error + */ + int (*start_beep)(struct udevice *dev, int frequency_hz); + + /** + * stop_beep() - Stop beeping (optional) + * + * This tells the sound hardware to stop a previously started beep. + * + * @dev: Sound device + * @return if OK, -ve on error + */ + int (*stop_beep)(struct udevice *dev); +}; + +#define sound_get_ops(dev) ((struct sound_ops *)(dev)->driver->ops) + +/** + * setup() - Set up to play a sound + */ +int sound_setup(struct udevice *dev); + +/** + * play() - Play a beep + * + * @dev: Sound device + * @msecs: Duration of beep in milliseconds + * @frequency_hz: Frequency of the beep in Hertz + * @return 0 if OK, -ve on error + */ +int sound_beep(struct udevice *dev, int msecs, int frequency_hz); + +/** + * sound_start_beep() - Start beeping + * + * This tells the sound hardware to start a beep. It will continue until stopped + * by sound_stop_beep(). + * + * @dev: Sound device + * @frequency_hz: Beep frequency in hertz + * @return if OK, -ve on error + */ +int sound_start_beep(struct udevice *dev, int frequency_hz); + +/** + * sound_stop_beep() - Stop beeping + * + * This tells the sound hardware to stop a previously started beep. + * + * @dev: Sound device + * @return if OK, -ve on error + */ +int sound_stop_beep(struct udevice *dev); + +/** + * sound_find_codec_i2s() - Called by sound drivers to locate codec and i2s * - * @return int 0 for success, -1 for error + * This finds the audio codec and i2s devices and puts them in the uclass's + * private data for this device. */ -int sound_play(uint32_t msec, uint32_t frequency); +int sound_find_codec_i2s(struct udevice *dev); #endif /* __SOUND__H__ */