aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gaudio/pwm/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/gaudio/pwm/readme.txt')
-rw-r--r--drivers/gaudio/pwm/readme.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/drivers/gaudio/pwm/readme.txt b/drivers/gaudio/pwm/readme.txt
new file mode 100644
index 00000000..1dd3ed9a
--- /dev/null
+++ b/drivers/gaudio/pwm/readme.txt
@@ -0,0 +1,12 @@
+This driver uses a PWM output and a timer to implement an audio play channel.
+
+Whilst the default config settings will probably work for your hardware, you may need to change them.
+If so copy gaudio_play_config.h to your project directory and then alter it.
+
+The maximum sample frequency is governed primarily by the number of bits of resolution and the
+maximum PWM clock rate. The maximum sample frequency should be less than...
+
+ Max PWM Clock / (2 ^ Bits per sample)
+
+eg. For the AT91SAM7 max PWM clock = 48MHz / 2
+ For 10 bit PWM accuracy that means GAUDIO_PLAY_MAX_SAMPLE_FREQUENCY = 23,437 Hz