include/sound.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (C) 2012 Samsung Electronics
   4  * R. Chandrasekar < [email protected]>
   5  */
   6
   7 #ifndef __SOUND_H__
   8 #define __SOUND_H__
   9
  10 /* sound codec enum */
  11 enum sound_compat {
  12         AUDIO_COMPAT_SPI,
  13         AUDIO_COMPAT_I2C,
  14 };
  15
  16 /* Codec information structure to store the info from device tree */
  17 struct sound_codec_info {
  18         int i2c_bus;
  19         int i2c_dev_addr;
  20 };
  21
  22 /**
  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  */
  31 struct sound_uc_priv {
  32         struct udevice *codec;
  33         struct udevice *i2s;
  34         int setup_done;
  35 };
  36
  37 /**
  38  * Generates square wave sound data for 1 second
  39  *
  40  * @param sample_rate   Sample rate in Hz
  41  * @param data          data buffer pointer
  42  * @param size          size of the buffer in bytes
  43  * @param freq          frequency of the wave
  44  */
  45 void sound_create_square_wave(uint sample_rate, unsigned short *data, int size,
  46                               uint freq);
  47
  48 /*
  49  * Initialises audio sub system
  50  * @param blob  Pointer of device tree node or NULL if none.
  51  * @return      int value 0 for success, -1 for error
  52  */
  53 int sound_init(const void *blob);
  54
  55 #ifdef CONFIG_DM_SOUND
  56 /*
  57  * The sound uclass brings together a data transport (currently only I2C) and a
  58  * codec (currently connected over I2C).
  59  */
  60
  61 /* Operations for sound */
  62 struct sound_ops {
  63         /**
  64          * setup() - Set up to play a sound
  65          */
  66         int (*setup)(struct udevice *dev);
  67
  68         /**
  69          * play() - Play a beep
  70          *
  71          * @dev: Sound device
  72          * @data: Data buffer to play
  73          * @data_size: Size of data buffer in bytes
  74          * @return 0 if OK, -ve on error
  75          */
  76         int (*play)(struct udevice *dev, void *data, uint data_size);
  77 };
  78
  79 #define sound_get_ops(dev)      ((struct sound_ops *)(dev)->driver->ops)
  80
  81 /**
  82  * setup() - Set up to play a sound
  83  */
  84 int sound_setup(struct udevice *dev);
  85
  86 /**
  87  * play() - Play a beep
  88  *
  89  * @dev: Sound device
  90  * @msecs: Duration of beep in milliseconds
  91  * @frequency_hz: Frequency of the beep in Hertz
  92  * @return 0 if OK, -ve on error
  93  */
  94 int sound_beep(struct udevice *dev, int msecs, int frequency_hz);
  95
  96 /**
  97  * sound_find_codec_i2s() - Called by sound drivers to locate codec and i2s
  98  *
  99  * This finds the audio codec and i2s devices and puts them in the uclass's
 100  * private data for this device.
 101  */
 102 int sound_find_codec_i2s(struct udevice *dev);
 103
 104 #else
 105 /*
 106  * plays the pcm data buffer in pcm_data.h through i2s1 to make the
 107  * sine wave sound
 108  *
 109  * @return      int 0 for success, -1 for error
 110  */
 111 int sound_play(uint32_t msec, uint32_t frequency);
 112 #endif /* CONFIG_DM_SOUND */
 113
 114 #endif  /* __SOUND__H__ */