Permalink
Browse files

uhd: added/renamed various readme files

  • Loading branch information...
1 parent 04e9d23 commit 1e3cb86432ee1d695a12fd99590206e43caab2cc @guruofquality guruofquality committed Feb 4, 2012
Showing with 50 additions and 81 deletions.
  1. +19 −0 README.txt
  2. +0 −6 firmware/README
  3. +31 −0 firmware/README.txt
  4. +0 −71 fix-copyright-years
  5. +0 −4 fpga/README
  6. 0 images/{README → README.txt}
View
@@ -0,0 +1,19 @@
+########################################################################
+## Welcome to the USRP source code tree
+########################################################################
+
+host/
+
+ Description: source code for user-space driver
+
+firmware/
+
+ Description: source code for various micro processors
+
+fpga/
+
+ Description: source code for FPGA designs
+
+images/
+
+ Description: package builder for FPGA and firmware images
View
@@ -1,6 +0,0 @@
-########################################################################
-# Firmware for USRP devices
-########################################################################
-
-fx2 - firmware for USRP1
-zpu - firmware for USRP2 and N Series
View
@@ -0,0 +1,31 @@
+########################################################################
+# Firmware for USRP devices
+########################################################################
+
+fx2/
+
+ Description: firmware for FX2 device
+
+ Devices: USRP1 and B100
+
+ Tools: sdcc, cmake
+
+ Build Instructions:
+ 1) mkdir <build directory>
+ 2) cd <build directory>
+ 3) cmake <source directory>
+ 4) make
+
+zpu/
+
+ Description: firmware for soft CPU in FPGA
+
+ Devices: USRP2 and N Series
+
+ Tools: zpu-gcc, cmake
+
+ Build Instructions:
+ 1) mkdir <build directory>
+ 2) cd <build directory>
+ 3) cmake <source directory>
+ 4) make
View
@@ -1,71 +0,0 @@
-#!/usr/bin/env python
-
-import re
-import optparse
-import datetime
-import subprocess
-import multiprocessing
-
-co_line_matcher = re.compile('^.*Copyright (.*) Ettus Research LLC$')
-
-def command(*args): return subprocess.Popen(args, stdout=subprocess.PIPE).communicate()[0]
-
-def get_co_line(lines):
- for i, line in enumerate(lines[:5]):
- if co_line_matcher.match(line): return line, i
- return None, None
-
-def fix_co_years(files, keep_years):
- for file in files:
- print file
- lines = open(file).readlines()
- line, num = get_co_line(lines)
- if line is None: continue
-
- #extract the years from the git history
- log_years = map(
- lambda l: int(l.split()[-2]),
- filter(
- lambda l: l.startswith('Date'),
- command('git', 'log', file).splitlines(),
- ),
- )
- log_years = min(log_years), max(log_years)
-
- #extract years from co string
- try:
- co_years_str = co_line_matcher.match(line).groups()[0]
- co_years = map(int, co_years_str.split('-'))
- co_years = min(co_years), max(co_years)
- except Exception, e:
- print ' format error on line %d: "%s"'%(num, line), e
- continue
-
- #keep years means log years is a superset
- if keep_years: log_years = min(co_years+log_years), max(co_years+log_years)
-
- if log_years != co_years:
- print ' log years: %s != copyright years: %s'%(log_years, co_years)
- year_now = datetime.datetime.now().year
- all_years = min(log_years), max(list(log_years)+[year_now]) #add the current year
- all_years_str = '%s-%s'%all_years
- if all_years[0] == all_years[1]: all_years_str = str(all_years[0])
- new_text = ''.join(lines[:num] + [line.replace(co_years_str, all_years_str)] + lines[num+1:])
- open(file, 'w').write(new_text)
-
-if __name__ == "__main__":
- parser = optparse.OptionParser(usage="usage: %prog [options] path")
- parser.add_option("-k", "--keep", action="store_true", help="keep copyright years", default=False)
- (options, args) = parser.parse_args()
-
- #get recursive list of files in the repo
- files = command('git', 'ls-tree', '--name-only', 'HEAD', '-r', args[0]).splitlines()
-
- #start n+1 processes to handle the files
- num_procs = multiprocessing.cpu_count()
- procs = [multiprocessing.Process(
- target=lambda *files: fix_co_years(files, keep_years=options.keep),
- args=files[num::num_procs],
- ) for num in range(num_procs)]
- map(multiprocessing.Process.start, procs)
- map(multiprocessing.Process.join, procs)
View
@@ -1,4 +0,0 @@
-This is a placeholder for the fpga code (verilog, makefiles, corgens...)
-
-The layout should have a common library and various top level builds
-and testbenches that are organized hierarchically.
File renamed without changes.

0 comments on commit 1e3cb86

Please sign in to comment.