From da7fc08c15de77362312926052fb8d3c5076ff4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Robert=20J=C3=B6rdens?= <rj@quartiq.de>
Date: Mon, 31 May 2021 18:25:34 +0200
Subject: [PATCH] pounder: add comment on channel enum

---
 src/hardware/pounder/mod.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/hardware/pounder/mod.rs b/src/hardware/pounder/mod.rs
index 7257217..3f4cd3d 100644
--- a/src/hardware/pounder/mod.rs
+++ b/src/hardware/pounder/mod.rs
@@ -44,6 +44,8 @@ pub enum Error {
     Adc,
 }
 
+/// The numerical value (discriminant) of the Channel enum is the index in the attenuator shift
+/// register as well as the attenuator latch enable signal index on the GPIO extender.
 #[derive(Debug, Copy, Clone)]
 #[allow(dead_code)]
 pub enum Channel {