From: ianmdlvl <ianmdlvl>
Date: Sun, 26 Sep 2004 15:34:23 +0000 (+0000)
Subject: documentation comments
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ijackson/git?a=commitdiff_plain;h=523b7938d38391a2877d61f5c1ac4a7f29d39289;p=trains.git

documentation comments
---

diff --git a/iwjpictest/copybits.asm b/iwjpictest/copybits.asm
index a404711..2efab6b 100644
--- a/iwjpictest/copybits.asm
+++ b/iwjpictest/copybits.asm
@@ -1,5 +1,13 @@
 ; -*- fundamental -*-
 
+; This program:
+;   * copies input signals from input pins to output pins, as shown in
+;     the `TEST-LEFT' and `TEST-RIGHT' PIC pinout diagrams;
+;   * flashes PER-PIC-LED (pin 21) and FLASHER (pin 2) in the
+;     pattern [high-low] with 50% duty cycle with period approx 660ms
+;     (assuming 20MHz clock input).
+;   * leaves all other pins set to their default states (usually Z).
+
 	include		/usr/share/gputils/header/p18f458.inc
 
 ACCSFR		equ		0x0f00
diff --git a/iwjpictest/flasher.asm b/iwjpictest/flasher.asm
index 5e53372..de5489a 100644
--- a/iwjpictest/flasher.asm
+++ b/iwjpictest/flasher.asm
@@ -1,5 +1,11 @@
 ; -*- fundamental -*-
 
+; This program:
+;   * flashes PER-PIC-LED (pin 21) with the pattern
+;      [ L-H-Z L-H-L-H-Z L-H-L-H-L-H-Z ]
+;     where each state lasts approx. 160ms (at 20MHz clock).
+;   * leaves all other pins set to their default states (usually Z).
+
 	include		/usr/share/gputils/header/p18f458.inc
 
 COUNTFAST	equ		0x00
diff --git a/iwjpictest/serialloop.asm b/iwjpictest/serialloop.asm
index a404711..2efab6b 100644
--- a/iwjpictest/serialloop.asm
+++ b/iwjpictest/serialloop.asm
@@ -1,5 +1,13 @@
 ; -*- fundamental -*-
 
+; This program:
+;   * copies input signals from input pins to output pins, as shown in
+;     the `TEST-LEFT' and `TEST-RIGHT' PIC pinout diagrams;
+;   * flashes PER-PIC-LED (pin 21) and FLASHER (pin 2) in the
+;     pattern [high-low] with 50% duty cycle with period approx 660ms
+;     (assuming 20MHz clock input).
+;   * leaves all other pins set to their default states (usually Z).
+
 	include		/usr/share/gputils/header/p18f458.inc
 
 ACCSFR		equ		0x0f00