From 92a140d736eee2e4cf1a25824c0329189cd3e86f Mon Sep 17 00:00:00 2001
From: Peter McGoron <code@mcgoron.com>
Date: Sat, 8 Apr 2023 16:47:59 +0000
Subject: [PATCH] generate_csr_locations: documentation

---
 firmware/generate_csr_locations.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/firmware/generate_csr_locations.py b/firmware/generate_csr_locations.py
index 1e445bf..2956b7b 100644
--- a/firmware/generate_csr_locations.py
+++ b/firmware/generate_csr_locations.py
@@ -2,6 +2,12 @@
 import json
 import sys
 
+"""
+This file takes the csr.json file output by LiteX and extracts all
+CSRs that are handled by Upsilon directly. See the output file csr.json
+for layout.
+"""
+
 class CSRGenerator:
 	def __init__(self, json_file, registers, f):
 		self.registers = registers