├── .gitignore
├── screenshot.png
├── README.md
├── openocd.py
├── svd.glade
├── svd.py
├── widgets.py
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | *.svd
2 | __pycache__
3 | 


--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/carrotIndustries/svdregview/HEAD/screenshot.png


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | svdregview
 2 | ==========
 3 | 
 4 | svdregview is a small Gtk+ utility written in python3 to access peripheral registers of ARM 
 5 | MCUs. It seeks to provide functionality similar to the 
 6 | KEIL™ System Viewer.
 7 | 
 8 | # How it works
 9 | svdregview leverages the CMSIS System View Description file format to obtain 
10 | the names and addresses of peripheral registers. SVD files for various 
11 | MCUs can be obtained from [cmis.arm.com](http://cmsis.arm.com/) (after registration). 
12 | The MCU is accessed via OpenOCD's telnet interface. 
13 | 
14 | # How do I use
15 |  - clone this repo
16 |  - get SVD file for your MCU (see above)
17 |  - start openocd
18 |  - ./svd.py <your-svd-file>
19 | 
20 | # How it looks like
21 | ![screenshot](screenshot.png?raw=true)
22 | 
23 | # Dependencies
24 |  - python3
25 |  - openocd
26 |  - Gtk+ 3
27 |  - python gobject introspection
28 | 
29 | # Bugs / missing features
30 |  - no support for enumerated register fields (ST, please add enumerations to your SVD files and headers. Atmel does)
31 |  - can't close openocd connection (have to exit svdregview before programming MCU)
32 |  - only tested with STM32F4 series MCUs
33 | 


--------------------------------------------------------------------------------
/openocd.py:
--------------------------------------------------------------------------------
 1 | import telnetlib
 2 | 
 3 | class OOCDTelnet:
 4 | 	def __init__(self, host="localhost", port=4444,timeout=1): 
 5 | 		self.tel = telnetlib.Telnet(host, port) 
 6 | 		self.timeout = timeout
 7 | 		self.read_data()
 8 | 	
 9 | 	def close(self): 
10 | 		self.tel.close()
11 | 
12 | 	def read_data(self): 
13 | 		return self.tel.read_until(b"\r\n\r", self.timeout).decode()
14 | 
15 | 	def command(self, com): 
16 | 		self.tel.write(("%s\r\n" % com).encode()) 
17 | 		return self.read_data()
18 | 		
19 | 	def parse_response(self, resp) :
20 | 		return int([x for x in resp.split("\n") if len(x)][1].split(":")[1].strip(), 16)
21 | 	
22 | 	def size_to_char(self, size) :
23 | 		if size == 32 :
24 | 			return "w"
25 | 		elif size == 16 :
26 | 			return "h"
27 | 		elif size == 8 :
28 | 			return "b"
29 | 		else :
30 | 			raise ValueError
31 | 		
32 | 	
33 | 	def memory_read(self, addr, size=32) :
34 | 		#print("readmem")
35 | 		return self.parse_response(self.command("md{:s} 0x{:x}".format(self.size_to_char(size), addr)))
36 | 
37 | 	def memory_write(self, addr, value, size=32) :
38 | 		#print("writemem")
39 | 		self.command("mw{:s} 0x{:x} 0x{:x}".format(self.size_to_char(size), addr, value))
40 | 
41 | if __name__ == "__main__" :
42 | 	tn = OOCDTelnet()
43 | 


--------------------------------------------------------------------------------
/svd.glade:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!-- Generated with glade 3.18.3 -->
 3 | <interface>
 4 |   <requires lib="gtk+" version="3.12"/>
 5 |   <object class="GtkWindow" id="window1">
 6 |     <property name="can_focus">False</property>
 7 |     <signal name="destroy" handler="quit" swapped="no"/>
 8 |     <child>
 9 |       <object class="GtkScrolledWindow" id="scrolledwindow1">
10 |         <property name="visible">True</property>
11 |         <property name="can_focus">True</property>
12 |         <property name="shadow_type">in</property>
13 |         <child>
14 |           <object class="GtkViewport" id="viewport1">
15 |             <property name="visible">True</property>
16 |             <property name="can_focus">False</property>
17 |             <child>
18 |               <object class="GtkBox" id="box1">
19 |                 <property name="visible">True</property>
20 |                 <property name="can_focus">False</property>
21 |                 <property name="orientation">vertical</property>
22 |                 <child>
23 |                   <placeholder/>
24 |                 </child>
25 |                 <child>
26 |                   <placeholder/>
27 |                 </child>
28 |                 <child>
29 |                   <placeholder/>
30 |                 </child>
31 |               </object>
32 |             </child>
33 |           </object>
34 |         </child>
35 |       </object>
36 |     </child>
37 |   </object>
38 | </interface>
39 | 


--------------------------------------------------------------------------------
/svd.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/python
  2 | import gi
  3 | gi.require_version('Gtk', '3.0')
  4 | from gi.repository import Gtk, GObject
  5 | import xml.dom.minidom as dom
  6 | import sys
  7 | import copy
  8 | import operator
  9 | 
 10 | from widgets import *
 11 | from openocd import *
 12 | 
 13 | class Peripheral :
 14 | 	def __init__(self, name, description, group, base_address) :
 15 | 		self.__dict__.update({(k,v) for k,v in locals().items() if k != "self"})
 16 | 		self.registers = {}
 17 | 	
 18 | 	def append_register(self, reg) :
 19 | 		reg.peripheral = self
 20 | 		self.registers[reg.name] = reg
 21 | 	
 22 | 	def copy(self) :
 23 | 		return copy.deepcopy(self)
 24 | 		
 25 | 	def __repr__(self) :
 26 | 		return "Peripheral "+self.name+"@"+hex(self.base_address)
 27 | 
 28 | class Register :
 29 | 	def __init__(self, name, display_name, description, address_offset, size, readable, writable, reset_value) :
 30 | 		self.__dict__.update({(k,v) for k,v in locals().items() if k != "self"})
 31 | 		self.fields = {}
 32 | 		self.cbs = []
 33 | 		self._auto = False
 34 | 		self._value = reset_value
 35 | 	
 36 | 	def bind(self, cb) :
 37 | 		self.cbs.append(cb)
 38 | 	
 39 | 	def append_field(self, field) :
 40 | 		field.register = self
 41 | 		self.fields[field.name] = field
 42 | 	
 43 | 	def trigger(self) :
 44 | 		for cb in self.cbs :
 45 | 			#print("calling", cb, self._value)
 46 | 			cb(self._value)
 47 | 		for field in self.fields.values() :
 48 | 			for cb in field.cbs :
 49 | 				cb(field.value)
 50 | 				
 51 | 	def read(self) :
 52 | 		self.value = self.peripheral.connection.memory_read(self.peripheral.base_address+self.address_offset, size=self.size)
 53 | 		self.trigger()
 54 | 		
 55 | 	def write(self) :
 56 | 		self.peripheral.connection.memory_write(self.peripheral.base_address+self.address_offset, self.value, size=self.size)
 57 | 	
 58 | 	@property
 59 | 	def auto(self) :
 60 | 		return self._auto
 61 | 		
 62 | 	@auto.setter
 63 | 	def auto(self, v) :
 64 | 		self._auto = v
 65 | 		if self._auto :
 66 | 			self.write()
 67 | 			self.read()
 68 | 		
 69 | 	
 70 | 	@property
 71 | 	def value(self) :
 72 | 		return self._value
 73 | 	
 74 | 	@value.setter
 75 | 	def value(self, v) :
 76 | 		print("setting", self.name, v)
 77 | 		if v<0 :
 78 | 			traceback.print_stack()
 79 | 			v=0
 80 | 		print("setting", self.name, v)
 81 | 		if v != self._value :
 82 | 			print("really setting", self.name, v)
 83 | 			self._value = v
 84 | 			self.trigger()
 85 | 			if self.auto :
 86 | 				self.write()
 87 | 				self.read()
 88 | 			
 89 | class RegisterField :
 90 | 	def __init__(self, name, description, offset, width) :
 91 | 		self.__dict__.update({(k,v) for k,v in locals().items() if k != "self"})
 92 | 		self._value = 0
 93 | 		self.cbs = []
 94 | 	
 95 | 	def bind(self, cb) :
 96 | 		self.cbs.append(cb)
 97 | 	
 98 | 	
 99 | 	@property
100 | 	def value(self) :
101 | 		return (self.register.value>>self.offset)&(2**self.width-1)
102 | 	
103 | 	@value.setter
104 | 	def value(self, vn) :
105 | 		v = self.register.value
106 | 		v &= ~((2**self.width-1)<<self.offset)
107 | 		v |= vn<<self.offset
108 | 		self.register.value = v
109 | 
110 | xml=dom.parse(sys.argv[1])
111 | device = xml.getElementsByTagName("device")[0]
112 | peripheralsNode = device.getElementsByTagName("peripherals")[0]
113 | peripherals = {}
114 | 
115 | 
116 | for peripheral in  [node for node in peripheralsNode.getElementsByTagName("peripheral") if node.parentNode==peripheralsNode] :
117 | 	if peripheral.getAttribute("derivedFrom") == "" :
118 | 		name         = [node for node in peripheral.childNodes if node.nodeName=="name"][0].firstChild.nodeValue
119 | 		description  = " ".join([node for node in peripheral.childNodes if node.nodeName=="description"][0].firstChild.nodeValue.split())
120 | 		try :
121 | 			group        = [node for node in peripheral.childNodes if node.nodeName=="group"][0].firstChild.nodeValue
122 | 		except IndexError :
123 | 			group = ""
124 | 		base_address = int([node for node in peripheral.childNodes if node.nodeName=="baseAddress"][0].firstChild.nodeValue, 0)
125 | 		#print(name, description, group, base_address)
126 | 		p = Peripheral(name, description, group, base_address)
127 | 		peripherals[p.name] = p
128 | 		for register in [node for node in peripheral.getElementsByTagName("registers")[0].childNodes if node.nodeName=="register"] :
129 | 			name         = [node for node in register.childNodes if node.nodeName=="name"][0].firstChild.nodeValue
130 | 			try :
131 | 				display_name = [node for node in register.childNodes if node.nodeName=="display_name"][0].firstChild.nodeValue
132 | 			except IndexError :
133 | 				display_name = name
134 | 			description = " ".join([node for node in register.childNodes if node.nodeName=="description"][0].firstChild.nodeValue.split())
135 | 			address_offset = int([node for node in register.childNodes if node.nodeName=="addressOffset"][0].firstChild.nodeValue, 0)
136 | 			size = int([node for node in register.childNodes if node.nodeName=="size"][0].firstChild.nodeValue, 0)
137 | 			try :
138 | 				reset_value = int([node for node in register.childNodes if node.nodeName=="resetValue"][0].firstChild.nodeValue, 0)
139 | 			except (IndexError, ValueError) :
140 | 				reset_value = 0
141 | 			try :
142 | 				readable = "read" in [node for node in register.childNodes if node.nodeName=="access"][0].firstChild.nodeValue
143 | 				writable = "write" in [node for node in register.childNodes if node.nodeName=="access"][0].firstChild.nodeValue
144 | 			except IndexError :
145 | 				readable = True
146 | 				writable = True
147 | 			r=Register(name, display_name, description, address_offset, size, readable, writable, reset_value)
148 | 			p.append_register(r)
149 | 			fields = register.getElementsByTagName("fields")
150 | 			if fields.length > 0:
151 | 				for field in [node for node in fields[0].childNodes if node.nodeName=="field"] :
152 | 					name         = [node for node in field.childNodes if node.nodeName=="name"][0].firstChild.nodeValue
153 | 					description         = " ".join([node for node in field.childNodes if node.nodeName=="description"][0].firstChild.nodeValue.split())
154 | 					offset         = int([node for node in field.childNodes if node.nodeName=="bitOffset"][0].firstChild.nodeValue, 0)
155 | 					width         = int([node for node in field.childNodes if node.nodeName=="bitWidth"][0].firstChild.nodeValue, 0)
156 | 					f=RegisterField(name, description, offset, width)
157 | 					r.append_field(f)
158 | 			#r.reset()
159 | 		
160 | 	else :
161 | 		derived = peripheral.getAttribute("derivedFrom")
162 | 		p = peripherals[derived].copy()
163 | 		p.name = [node for node in peripheral.childNodes if node.nodeName=="name"][0].firstChild.nodeValue
164 | 		p.base_address = int([node for node in peripheral.childNodes if node.nodeName=="baseAddress"][0].firstChild.nodeValue, 0)
165 | 		peripherals[p.name] = p
166 | 
167 | 
168 | 
169 | builder = Gtk.Builder()
170 | builder.add_from_file("svd.glade")
171 | 
172 | window = builder.get_object("window1")
173 | window.show_all()
174 | 
175 | class Handler :	
176 | 	def quit(self, widget) :
177 | 		Gtk.main_quit()
178 | 
179 | builder.connect_signals(Handler())
180 | 
181 | 
182 | peripheralwidgets = []
183 | 
184 | connection = OOCDTelnet()
185 | 
186 | for peripheral in peripherals.values() :
187 | 	peripheral.connection=connection
188 | 
189 | 
190 | box = builder.get_object("box1")
191 | for peripheral in sorted(peripherals.values(), key=operator.attrgetter("name")) :
192 | 	peripheralwidget = PeripheralWidget(peripheral)
193 | 	peripheralwidgets.append(peripheralwidget)
194 | 	
195 | 
196 | 	
197 | 		
198 | 		
199 | 	box.pack_start(peripheralwidget, True, True, 0)
200 | box.show_all()
201 | 
202 | Gtk.main()
203 | 
204 | 


--------------------------------------------------------------------------------
/widgets.py:
--------------------------------------------------------------------------------
  1 | from gi.repository import Gtk, GObject
  2 | import operator
  3 | import traceback
  4 | import re
  5 | 
  6 | def userevent(f) :
  7 | 	def inner(*args, **kwargs) :
  8 | 		if Gtk.get_current_event() is not None :
  9 | 			f(*args, **kwargs)
 10 | 	return inner
 11 | 
 12 | 
 13 | class PeripheralWidget (Gtk.Expander):
 14 | 	def __init__(self, peripheral) :
 15 | 		self.peripheral = peripheral
 16 | 		Gtk.Expander.__init__(self)
 17 | 		self.set_label(peripheral.name + " (" + peripheral.description+")")
 18 | 		self.box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
 19 | 		self.box.set_margin_start(16)
 20 | 		self.add(self.box)
 21 | 		self.connect("activate", self.expanded_handler)
 22 | 		self.populated = False
 23 | 		self.registers = []
 24 | 	
 25 | 	def expanded_handler(self, w) :
 26 | 		print("expand", self.get_expanded(), self.populated)
 27 | 		if not self.populated :
 28 | 			self.populated = True
 29 | 			for register in sorted(self.peripheral.registers.values(), key=operator.attrgetter("name")) :
 30 | 				regwidget = RegisterWidget(register)
 31 | 				self.append_register(regwidget)
 32 | 				for field in reversed(sorted(register.fields.values(), key=operator.attrgetter("offset"))) :
 33 | 					fieldwidget = RegisterFieldWidget(field)
 34 | 					regwidget.append_field(fieldwidget)
 35 | 				register.trigger()
 36 | 			
 37 | 	def append_register(self, reg) :
 38 | 		self.registers.append(reg)
 39 | 		self.box.pack_start(reg, True, True, 0)
 40 | 		reg.show_all()
 41 | 
 42 | 
 43 | class ComboEntry (Gtk.Box) :
 44 | 	
 45 | 	__gsignals__ = {
 46 | 		"value-changed":(GObject.SIGNAL_RUN_FIRST , GObject.TYPE_NONE, (GObject.TYPE_UINT, )),
 47 | 	}
 48 | 	
 49 | 	def __init__(self, lo, hi) :
 50 | 		Gtk.Box.__init__(self)
 51 | 		self.set_spacing(4)
 52 | 		self.hexentry = Gtk.SpinButton.new_with_range(lo, hi, 1)
 53 | 		self.hexentry.set_numeric(False)
 54 | 		self.hexentry.connect("value-changed", self.decentry_handler)
 55 | 		self.hexentry.connect("output", self.hexentry_output)
 56 | 		self.pack_start(self.hexentry, True, True, 0)
 57 | 		
 58 | 		self.decentry = Gtk.SpinButton.new_with_range(lo, hi, 1)
 59 | 		self.pack_start(self.decentry, True, True, 0)
 60 | 		self.decentry.connect("value-changed", self.decentry_handler)
 61 | 		
 62 | 	def set_value(self, v) :
 63 | 		self.decentry.set_value(v)
 64 | 		self.hexentry.set_value(v)
 65 | 		self.emit("value-changed", int(self.decentry.get_value()))
 66 | 	
 67 | 	def get_value(self) :
 68 | 		return int(self.decentry.get_value())
 69 | 	
 70 | 	def decentry_handler(self, w) :
 71 | 		self.set_value(w.get_value())
 72 | 	
 73 | 	def hexentry_output(self, w) :
 74 | 		v = int(w.get_adjustment().get_value())
 75 | 		w.set_text(hex(v))
 76 | 		#print("sethex", self, v)
 77 | 		#traceback.print_stack()
 78 | 		return True
 79 | 
 80 | 
 81 | class RegisterWidget (Gtk.Expander):
 82 | 	def __init__(self, register) :
 83 | 		self.register = register
 84 | 		
 85 | 		Gtk.Expander.__init__(self)
 86 | 		self.connect("activate", self.expanded_handler)
 87 | 		self.set_label(register.name + f" ({register.description})")
 88 | 		self.outerbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=4)
 89 | 		self.outerbox.set_border_width(8)
 90 | 		self.box = Gtk.FlowBox()
 91 | 		self.box.set_selection_mode(Gtk.SelectionMode.NONE)
 92 | 		self.box.set_max_children_per_line(8)
 93 | 		self.outerbox.set_margin_start(16)
 94 | 		
 95 | 		self.bbox = Gtk.ButtonBox(orientation=Gtk.Orientation.HORIZONTAL)
 96 | 		self.bbox.set_layout(Gtk.ButtonBoxStyle.START)
 97 | 		self.bbox.set_spacing(16)
 98 | 		
 99 | 		self.writebutton = Gtk.Button.new_from_icon_name("gtk-apply", Gtk.IconSize.BUTTON)
100 | 		self.writebutton.connect("clicked", self.write_clicked)
101 | 		self.writebutton.set_label("Write")
102 | 		self.bbox.add(self.writebutton)
103 | 		
104 | 		self.readbutton = Gtk.Button.new_from_icon_name("view-refresh", Gtk.IconSize.BUTTON)
105 | 		self.readbutton.connect("clicked", self.read_clicked)
106 | 		self.readbutton.set_label("Read")
107 | 		self.bbox.add(self.readbutton)
108 | 		
109 | 		self.autobox = Gtk.Box(spacing=4)
110 | 		self.autoswitch = Gtk.Switch()
111 | 		self.autoswitch.set_valign(Gtk.Align.CENTER)
112 | 		self.autoswitch.connect("notify::active", self.auto_toggled)
113 | 		self.autobox.pack_start(self.autoswitch, False, False,0)
114 | 		self.autolabel = Gtk.Label("Auto write")
115 | 		self.autobox.pack_start(self.autolabel, False, False,0)
116 | 		self.bbox.add(self.autobox)
117 | 		
118 | 		
119 | 		self.outerbox.pack_start(self.bbox, True, True, 0)
120 | 		
121 | 		self.outerbox.pack_start(self.box, True, True, 0)
122 | 		
123 | 		self.comboentry = ComboEntry(0, (2**32)-1)
124 | 		self.comboentry.set_value(self.register.value)
125 | 		self.comboentry.connect("value-changed", self.comboentry_handler)
126 | 		self.outerbox.pack_start(self.comboentry, True, True, 0)
127 | 		self.register.bind(self.comboentry.set_value)
128 | 		self.add(self.outerbox)
129 | 		self.fields = []
130 | 	
131 | 	def expanded_handler(self, w) :
132 | 		pass
133 | 		self.register.read()
134 | 	
135 | 	def auto_toggled(self, w, v) :
136 | 		self.register.auto = w.get_active()
137 | 	
138 | 	def write_clicked(self, w) :
139 | 		self.register.write()
140 | 		self.register.read()
141 | 		
142 | 	def read_clicked(self, w) :
143 | 		self.register.read()
144 | 	
145 | 	def comboentry_handler(self, w, v) :
146 | 		self.register.value = v
147 | 	
148 | 	def append_field(self, field) :
149 | 		self.fields.append(field)
150 | 		self.box.insert(field, -1)
151 | 		field.show_all()
152 | 	
153 | 
154 | class RegisterFieldWidget (Gtk.Frame) :
155 | 	def __init__(self, field) :
156 | 		self.field = field
157 | 		self.field.bind(self.set_value)
158 | 		Gtk.Frame.__init__(self, label="[{:d}:{:d}] {:s}".format(field.offset+field.width-1, field.offset, field.name))
159 | 		self.set_tooltip_text(field.description)
160 | 		self.set_shadow_type(Gtk.ShadowType.IN)
161 | 		self.outerbox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=4)
162 | 		self.outerbox.set_border_width(4)
163 | 		self.add(self.outerbox)
164 | 		self.box = Gtk.Box()
165 | 		self.last_value = None
166 | 		self.outerbox.pack_start(self.box, True, True, 0)
167 | 		if self.field.width > 1:
168 | 			self.comboentry = ComboEntry(0, (2**field.width)-1)
169 | 			self.comboentry.set_value(self.field.value)
170 | 			self.outerbox.pack_start(self.comboentry, True, True, 0)
171 | 			
172 | 			self.comboentry.connect("value-changed", self.comboentry_handler)
173 | 			
174 | 		else :
175 | 			self.comboentry = None
176 | 		self.bits = {}
177 | 		for i in reversed(range(self.field.width)) :
178 | 			checkbutton = Gtk.CheckButton(label=str(i))
179 | 			checkbutton.set_active(self.field.value&(1<<i))
180 | 			checkbutton.connect("toggled", self.checkbutton_handler)
181 | 			self.bits[i] = checkbutton
182 | 			self.box.pack_start(checkbutton, True, True, 0)
183 | 	
184 | 
185 | 	
186 | 	def comboentry_handler(self, w,v ) :
187 | 		self.set_value(w.get_value())
188 | 	
189 | 	def hexentry_output(self, w) :
190 | 		v = int(w.get_adjustment().get_value())
191 | 		w.set_text(hex(v))
192 | 		return True
193 | 	
194 | 	@userevent
195 | 	def checkbutton_handler(self, w) :
196 | 		if Gtk.get_event_widget(Gtk.get_current_event()) != w :
197 | 			return
198 | 		print("cbh")
199 | 		va=0
200 | 		for k,v in self.bits.items() :
201 | 			if v.get_active() :
202 | 				va |= (1<<k)
203 | 		self.set_value(va)
204 | 	
205 | 	def set_value(self, v) :
206 | 		if v == self.last_value :
207 | 			return
208 | 		self.last_value = v
209 | 		v=int(v)
210 | 		if v<0 : 
211 | 			v=0
212 | 		elif v>=2**(self.field.width) :
213 | 			v=2**(self.field.width)-1
214 | 		for i in range(0, self.field.width) :
215 | 			self.bits[i].set_active(v&(1<<i))
216 | 		if self.comboentry is not None :
217 | 			self.comboentry.set_value(v)
218 | 		self.field.value = v
219 | 		
220 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
  5 |  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 |                             Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                     GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 |                             NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 
280 |                      END OF TERMS AND CONDITIONS
281 | 
282 |             How to Apply These Terms to Your New Programs
283 | 
284 |   If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 | 
288 |   To do so, attach the following notices to the program.  It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 | 
293 |     {description}
294 |     Copyright (C) {year}  {fullname}
295 | 
296 |     This program is free software; you can redistribute it and/or modify
297 |     it under the terms of the GNU General Public License as published by
298 |     the Free Software Foundation; either version 2 of the License, or
299 |     (at your option) any later version.
300 | 
301 |     This program is distributed in the hope that it will be useful,
302 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
303 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304 |     GNU General Public License for more details.
305 | 
306 |     You should have received a copy of the GNU General Public License along
307 |     with this program; if not, write to the Free Software Foundation, Inc.,
308 |     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 | 
310 | Also add information on how to contact you by electronic and paper mail.
311 | 
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 | 
315 |     Gnomovision version 69, Copyright (C) year name of author
316 |     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 |     This is free software, and you are welcome to redistribute it
318 |     under certain conditions; type `show c' for details.
319 | 
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License.  Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 | 
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary.  Here is a sample; alter the names:
328 | 
329 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 |   `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 | 
332 |   {signature of Ty Coon}, 1 April 1989
333 |   Ty Coon, President of Vice
334 | 
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs.  If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library.  If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 | 
341 | 


--------------------------------------------------------------------------------