├── README.md ├── gdb-svd.py └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # svd-tools Repository 2 | 3 | This repository groups a set of tools using svd features. 4 | 5 | [SVD](https://arm-software.github.io/CMSIS_5/SVD/html/index.html): System View Description: 6 | > The CMSIS System View Description format(CMSIS-SVD) formalizes the description of the system 7 | > contained in Arm Cortex-M processor-based microcontrollers, in particular, the memory mapped 8 | > registers of peripherals. The detail contained in system view descriptions is comparable to 9 | > the data in device reference manuals. The information ranges from high level functional 10 | > descriptions of a peripheral all the way down to the definition and purpose of an individual 11 | > bit field in a memory mapped register. 12 | 13 | ## gdb-svd 14 | It's a python module for gdb. This adds some gdb commands to: 15 | - get information on peripherals | registers | fields 16 | - get registers values | register fields 17 | - set registers values | register fields 18 | - dump registers values to file 19 | 20 | ### Dependencies 21 | - [openocd](http://openocd.org/) or other 22 | - [gdb](https://www.gnu.org/software/gdb/) 23 | - [cmsis-svd](https://pypi.org/project/cmsis-svd/) python: cmsis-svd parser 24 | - [terminaltables](https://pypi.org/project/terminaltables/) python: terminaltables 25 | 26 | > On microprocessor: I advise to use openocd, in order to access at physical memory 27 | > without need to enable/disable MMU (thanks to openocd with `mdw phys` 28 | > option). 29 | 30 | ### How to use 31 | These commands support tab completion to look-up file, peripherals, registers or fields 32 | - Source the gdb-svd module in gdb interface: 33 | ``` 34 | (gdb) source ../svd_tools/gdb-svd.py 35 | ``` 36 | - Load svd file descriptor for your microcontroller (it might several seconds depending on the file size): 37 | ``` 38 | (gdb) svd ../cmsis-svd/data/STMicro/STM32F7x9.svd 39 | Svd Loading ../cmsis-svd/data/STMicro/STM32F7x9.svd Done 40 | ``` 41 | 42 | - Help: 43 | ``` 44 | (gdb) help svd 45 | The CMSIS SVD (System View Description) inspector commands 46 | This allows easy access to all peripheral registers supported by the system 47 | in the GDB debug environment 48 | 49 | svd [filename] load an SVD file and to create the command for inspecting 50 | that object 51 | 52 | List of svd subcommands: 53 | svd dump -- Get register(s) value(s): svd dump [peripheral] 54 | svd get -- Get register(s) value(s): svd get [peripheral] [register] 55 | svd info -- Info on Peripheral|register|field: svd info [register] [field] 56 | svd set -- Set register value: svd set [field] 57 | ``` 58 | #### Info on peripheral register field 59 | 60 | > **Note**: 61 | > The last parameter can be or not a fullname, a filter is applied with your string. 62 | 63 | - Information on all ADC 64 | ``` 65 | (gdb) svd info ADC 66 | +Peripherals--------+--------+-----------------------------+ 67 | | name | base | access | description | 68 | +------+------------+--------+-----------------------------+ 69 | | ADC1 | 0x40012000 | None | Analog-to-digital converter | 70 | | ADC2 | 0x40012100 | None | Analog-to-digital converter | 71 | | ADC3 | 0x40012200 | None | Analog-to-digital converter | 72 | +------+------------+--------+-----------------------------+ 73 | ``` 74 | - Information on all ADC1 registers beginning by S 75 | ``` 76 | (gdb) svd info ADC1 S 77 | +Registers-----------+------------+-----------------------------+ 78 | | name | address | access | description | 79 | +-------+------------+------------+-----------------------------+ 80 | | SR | 0x40012000 | read-write | status register | 81 | | SMPR1 | 0x4001200c | read-write | sample time register 1 | 82 | | SMPR2 | 0x40012010 | read-write | sample time register 2 | 83 | | SQR1 | 0x4001202c | read-write | regular sequence register 1 | 84 | | SQR2 | 0x40012030 | read-write | regular sequence register 2 | 85 | | SQR3 | 0x40012034 | read-write | regular sequence register 3 | 86 | +-------+------------+------------+-----------------------------+ 87 | ``` 88 | - Information on all fields (peripheral: ADC1 register: CR1) beginning by J 89 | ``` 90 | (gdb) svd info ADC1 CR1 J 91 | +Fields---+-----------+--------+---------------------------------------------+ 92 | | name | [msb:lsb] | access | description | 93 | +---------+-----------+--------+---------------------------------------------+ 94 | | JAWDEN | [22:22] | None | Analog watchdog enable on injected channels | 95 | | JDISCEN | [12:12] | None | Discontinuous mode on injected channels | 96 | | JAUTO | [10:10] | None | Automatic injected group conversion | 97 | | JEOCIE | [7:7] | None | Interrupt enable for injected channels | 98 | +---------+-----------+--------+---------------------------------------------+ 99 | ``` 100 | #### Get value 101 | - Get all registers of WWDG 102 | ``` 103 | (gdb) svd get WWDG 104 | +Registers----------+------------+----------------------------------------------------------+ 105 | | name | address | value | fields | 106 | +------+------------+------------+----------------------------------------------------------+ 107 | | CR | 0x40002c00 | 0x0000007f | WDGA[7:7]=0x0 T[6:0]=0x7f | 108 | | CFR | 0x40002c04 | 0x0000007f | EWI[9:9]=0x0 WDGTB1[8:8]=0x0 WDGTB0[7:7]=0x0 W[6:0]=0x7f | 109 | | SR | 0x40002c08 | 0x00000000 | EWIF[0:0]=0x0 | 110 | +------+------------+------------+----------------------------------------------------------+ 111 | ``` 112 | - Get fields of RCC AHB3ENR 113 | ``` 114 | (gdb) svd get RCC AHB3ENR 115 | +Registers+------------+------------+--------------------------------+ 116 | | name | address | value | fields | 117 | +---------+------------+------------+--------------------------------+ 118 | | AHB3ENR | 0x40023838 | 0x00000000 | FMCEN[0:0]=0x0 QSPIEN[1:1]=0x1 | 119 | +---------+------------+------------+--------------------------------+ 120 | ``` 121 | #### Set value 122 | - Set register value 123 | ``` 124 | (gdb) svd set RCC AHB3ENR 0x0 125 | ``` 126 | - Set field of 127 | ``` 128 | (gdb) svd set RCC AHB3ENR QSPIEN 0x1 129 | ``` 130 | #### Dump value in file 131 | - Dump value of all registers to file 132 | ``` 133 | (gdb) svd dump 134 | Print to file: 135 | ``` 136 | - Dump value of ADC1 to file 137 | ``` 138 | (gdb) svd dump ADC1 139 | Print to file: 140 | ``` 141 | ## Authors 142 | Ludovic Barre 1udovic.6arre@gmail.com 143 | 144 | ## License 145 | This project is licensed under the GPL V2 License - see the [LICENSE.md](LICENSE.md) file for details 146 | -------------------------------------------------------------------------------- /gdb-svd.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # 3 | # Copyright 2019 Ludovic Barre <1udovic.6arre@gmail.com> 4 | # 5 | # This file is part of svd-tools. 6 | # 7 | # svd-tools is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 2 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # svd-tools is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with svd-tools. If not, see . 19 | 20 | import re 21 | import gdb 22 | from terminaltables import AsciiTable 23 | from cmsis_svd.parser import SVDParser 24 | from textwrap import wrap 25 | 26 | class GdbSvd(gdb.Command): 27 | """The CMSIS SVD (System View Description) inspector commands 28 | 29 | This allows easy access to all peripheral registers supported by the system 30 | in the GDB debug environment 31 | 32 | svd [filename] load an SVD file and to create the command for inspecting 33 | that object 34 | """ 35 | def __init__(self): 36 | gdb.Command.__init__(self, "svd", gdb.COMMAND_DATA, gdb.COMPLETE_FILENAME, prefix = True) 37 | 38 | def invoke(self, arg, from_tty): 39 | try: 40 | argv = gdb.string_to_argv(arg) 41 | if len(argv) != 1: 42 | raise Exception("Invalid parameter") 43 | 44 | pathfile = argv[0] 45 | gdb.write("Svd Loading {} ".format(pathfile)) 46 | parser = SVDParser.for_xml_file(pathfile) 47 | device = parser.get_device() 48 | 49 | peripherals = dict((peripheral.name,peripheral) for peripheral in device.peripherals) 50 | 51 | except Exception as inst: 52 | gdb.write("\n{}\n".format(inst)) 53 | gdb.execute("help svd") 54 | except IOError: 55 | gdb.write("\nFailed to load SVD file\n") 56 | else: 57 | gdb.write("Done\n") 58 | 59 | GdbSvdGetCmd(device, peripherals) 60 | GdbSvdSetCmd(device, peripherals) 61 | GdbSvdInfoCmd(device, peripherals) 62 | GdbSvdDumpCmd(device, peripherals) 63 | 64 | if __name__ == "__main__": 65 | GdbSvd() 66 | 67 | class GdbSvdCmd(gdb.Command): 68 | def __init__(self, device, peripherals): 69 | self.device = device 70 | self.peripherals = peripherals 71 | self.column_with = 100 72 | version = gdbserver = [] 73 | 74 | try: 75 | version = gdb.execute("monitor version", False, True) 76 | except: 77 | pass 78 | 79 | try: 80 | gdbserver = gdb.execute("monitor gdbserver status", False, True) 81 | except: 82 | pass 83 | 84 | if "Open On-Chip Debugger" in version: 85 | self.read_cmd = "monitor mdw phys {address:#x}" 86 | self.write_cmd = "monitor mww phys {address:#x} {value:#x}" 87 | 88 | elif "gdbserver for" in gdbserver: 89 | self.read_cmd = "monitor rw {address:#x}" 90 | self.write_cmd = "monitor ww {address:#x} {value:#x}" 91 | else: 92 | self.read_cmd = "x /x {address:#x}" 93 | self.write_cmd = "set *(int *){address:#x}={value:#x}" 94 | 95 | def complete(self, text, word): 96 | args = str(text).split(" ") 97 | nb_args = len(args) 98 | 99 | if nb_args == 1: 100 | filt = filter(lambda x: x.upper().startswith(args[0].upper()), self.peripherals) 101 | return filt 102 | 103 | periph_name = args[0].upper() 104 | periph = self.peripherals[periph_name] 105 | reg_names = [reg.name for reg in periph.registers] 106 | 107 | if nb_args == 2 and reg_names: 108 | filt = filter(lambda x: x.upper().startswith(args[1].upper()), reg_names) 109 | return filt 110 | 111 | reg_name = args[1].upper() 112 | reg = [r for r in periph.registers if r.name == reg_name][0] 113 | field_names = [field.name for field in reg.fields] 114 | 115 | if nb_args == 3 and field_names: 116 | filt = filter(lambda x: x.upper().startswith(args[2].upper()), field_names) 117 | return filt 118 | 119 | return gdb.COMPLETE_NONE 120 | 121 | def get_registers_val(self, peripheral, registers): 122 | registers_val = [] 123 | 124 | for reg in registers: 125 | addr = peripheral.base_address + reg.address_offset 126 | 127 | try: 128 | val = self.read(peripheral, reg) 129 | 130 | if val is None: 131 | fval = val 132 | val = reg.access 133 | else: 134 | fval = self.get_fields_val(reg.fields, val) 135 | val = "0x{:08x}".format(val) 136 | except: 137 | val = "DataAbort" 138 | fval = "" 139 | 140 | addr = "0x{:08x}".format(addr) 141 | registers_val += [{"name": reg.name, 142 | "addr": addr, 143 | "value": val, 144 | "fields": fval}] 145 | 146 | return registers_val 147 | 148 | def get_fields_val(self, fields, reg_values): 149 | fields_val = [] 150 | 151 | for f in fields: 152 | lsb = f.bit_offset 153 | msb = f.bit_offset + f.bit_width - 1 154 | fname = "{}[{}:{}]".format(f.name, msb, lsb) 155 | fieldval = (reg_values >> lsb) & ((1 << f.bit_width) - 1) 156 | fields_val += [{"name": fname, "value": fieldval}] 157 | 158 | return fields_val 159 | 160 | def print_desc(self, peripherals, registers = None, fields = None): 161 | table_show = [] 162 | 163 | if fields is not None: 164 | desc_title = "Fields" 165 | table_show.append(["name", "[msb:lsb]", "access", "description"]) 166 | for f in fields: 167 | mlsb = "[{}:{}]".format(f.bit_offset, f.bit_offset + f.bit_width - 1) 168 | desc = '\n'.join(wrap(f.description, self.column_with)) 169 | table_show.append([f.name, mlsb, f.access, desc]) 170 | elif registers is not None: 171 | desc_title = "Registers" 172 | table_show.append(["name", "address", "access", "description"]) 173 | for r in registers: 174 | addr = r.parent.base_address + r.address_offset 175 | desc = '\n'.join(wrap(r.description, self.column_with)) 176 | table_show.append([r.name, "{:#x}".format(addr), r.access, desc]) 177 | elif peripherals is not None: 178 | desc_title = "Peripherals" 179 | table_show.append(["name", "base", "access", "description"]) 180 | for p in peripherals: 181 | desc = '\n'.join(wrap(p.description, self.column_with)) 182 | table_show.append([p.name, "{:#x}".format(p.base_address), p.access, desc]) 183 | 184 | desc_table = AsciiTable(table_show, title = desc_title) 185 | gdb.write("{}\n".format(desc_table.table)) 186 | 187 | def print_registers(self, peripheral, registers, output_file_name = "None", syntax_highlighting = True ): 188 | regs_table = [] 189 | reg_val = [] 190 | regs_table.append(["name", "address", "value", "fields"]) 191 | 192 | reg_val += self.get_registers_val(peripheral, registers) 193 | 194 | for r in reg_val: 195 | f_str = [] 196 | fields = r["fields"] 197 | if fields is not None: 198 | for f in fields: 199 | if f["value"] > 0 and syntax_highlighting == True: 200 | f_str.append("\033[94m{name}={value:#x}\033[0m".format(**f)) 201 | else: 202 | f_str.append("{name}={value:#x}".format(**f)) 203 | 204 | f_str = '\n'.join(wrap(" ".join(f_str), self.column_with)) 205 | regs_table.append([r["name"], r["addr"], r["value"], f_str]) 206 | rval_table = AsciiTable(regs_table, title=peripheral.name) 207 | 208 | if output_file_name == "None": 209 | gdb.write("{}\n".format(rval_table.table)) 210 | else: 211 | try: 212 | file_object = open(output_file_name, "a") 213 | file_object.write("{}\n".format(rval_table.table)) 214 | file_object.close() 215 | except: 216 | gdb.write("Error writting to file \n") 217 | 218 | def set_register(self, peripheral, register, value, field = None): 219 | val = value 220 | if field is not None: 221 | max_val = ((1 << field.bit_width) - 1) 222 | if value > max_val: 223 | raise Exception("Invalid value, > max of field") 224 | 225 | mask = max_val << field.bit_offset 226 | 227 | #read register value with gdb 228 | val = self.read(peripheral, register) 229 | if val is None: 230 | raise Exception("Register not readable") 231 | 232 | val &= ~mask 233 | val |= value << field.bit_offset 234 | 235 | # write val to target 236 | self.write(peripheral, register, val) 237 | 238 | def read(self, peripheral, register): 239 | """ Read register and return an integer 240 | """ 241 | #access could be not defined for a register 242 | if register.access in [None, "read-only", "read-write", "read-writeOnce"]: 243 | addr = peripheral.base_address + register.address_offset 244 | cmd = self.read_cmd.format(address=addr) 245 | pattern = re.compile('(?P\w+):( *?(?P[a-f0-9]+))') 246 | 247 | try: 248 | match = re.search(pattern, gdb.execute(cmd, False, True)) 249 | val = int(match.group('VALUE'), 16) 250 | except Exception as err: 251 | #if openocd can't access to addr => data abort 252 | return err 253 | return val 254 | else: 255 | return None 256 | 257 | def write(self, peripheral, register, val): 258 | """ Write data to memory 259 | """ 260 | if register.access in [None, "write-only", "read-write", "writeOnce", "read-writeOnce"]: 261 | addr = peripheral.base_address + register.address_offset 262 | cmd = self.write_cmd.format(address=addr, value=val) 263 | 264 | gdb.execute(cmd, False, True) 265 | else: 266 | raise Exception("Register not writable") 267 | 268 | # sub commands 269 | class GdbSvdGetCmd(GdbSvdCmd): 270 | """Get register(s) value(s): svd get [peripheral] [register] 271 | """ 272 | def __init__(self, device, peripherals): 273 | GdbSvdCmd.__init__(self, device, peripherals) 274 | gdb.Command.__init__(self, "svd get", gdb.COMMAND_DATA) 275 | 276 | def complete(self, text, word): 277 | args = str(text).split(" ") 278 | if len(args) > 2: 279 | return gdb.COMPLETE_NONE 280 | 281 | return GdbSvdCmd.complete(self, text, word) 282 | 283 | def invoke(self, arg, from_tty): 284 | args = str(arg).split(" ") 285 | if len(args) > 2: 286 | gdb.write("Invalid parameter\n") 287 | gdb.execute("help svd get") 288 | return 289 | 290 | try: 291 | periph_name = args[0].upper() 292 | periph = self.peripherals[periph_name] 293 | except: 294 | gdb.write("Invalid peripheral name\n") 295 | GdbSvdCmd.print_desc(self, self.device.peripherals, None, None) 296 | return 297 | 298 | try: 299 | regs = periph.registers 300 | 301 | if len(args) == 2: 302 | reg_name = args[1].upper() 303 | regs = [[r for r in regs if r.name == reg_name][0]] 304 | 305 | GdbSvdCmd.print_registers(self, periph, regs) 306 | 307 | except Exception as inst: 308 | gdb.write("{}\n".format(inst)) 309 | except: 310 | gdb.write("Error cannot get the value\n") 311 | 312 | class GdbSvdSetCmd(GdbSvdCmd): 313 | """Set register value: svd set [field] 314 | """ 315 | def __init__(self, device, peripherals): 316 | GdbSvdCmd.__init__(self, device, peripherals) 317 | gdb.Command.__init__(self, "svd set", gdb.COMMAND_DATA) 318 | 319 | def complete(self, text, word): 320 | args = str(text).split(" ") 321 | if len(args) > 3: 322 | return gdb.COMPLETE_NONE 323 | 324 | return GdbSvdCmd.complete(self, text, word) 325 | 326 | def invoke(self, arg, from_tty): 327 | args = str(arg).split(" ") 328 | 329 | try: 330 | periph_name = args[0].upper() 331 | periph = self.peripherals[periph_name] 332 | except: 333 | gdb.write("Invalid peripheral name\n") 334 | GdbSvdCmd.print_desc(self, self.device.peripherals, None, None) 335 | return 336 | 337 | if len(args) < 3 or len(args) > 4: 338 | gdb.write("Invalid parameter\n") 339 | gdb.execute("help svd set") 340 | return 341 | 342 | try: 343 | reg_name = args[1].upper() 344 | reg = [r for r in periph.registers if r.name == reg_name][0] 345 | field = None 346 | if len(args) == 4: 347 | field_name = args[2].upper() 348 | field = [f for f in reg.fields if f.name == field_name][0] 349 | value = int(args[3], 16) 350 | else: 351 | value = int(args[2], 16) 352 | 353 | GdbSvdCmd.set_register(self, periph, reg, value, field) 354 | 355 | except Exception as inst: 356 | gdb.write("{}\n".format(inst)) 357 | 358 | except: 359 | gdb.write("Error cannot set the value\n") 360 | 361 | class GdbSvdInfoCmd(GdbSvdCmd): 362 | """Info on Peripheral|register|field: svd info [register] [field] 363 | """ 364 | def __init__(self, device, peripherals): 365 | GdbSvdCmd.__init__(self, device, peripherals) 366 | gdb.Command.__init__(self, "svd info", gdb.COMMAND_DATA) 367 | 368 | def complete(self, text, word): 369 | args = str(text).split(" ") 370 | if len(args) > 3: 371 | return gdb.COMPLETE_NONE 372 | 373 | return GdbSvdCmd.complete(self, text, word) 374 | 375 | def invoke(self, arg, from_tty): 376 | args = str(arg).split(" ") 377 | 378 | if len(args) < 1 or len(args) > 3: 379 | gdb.write("Invalid parameter\n") 380 | gdb.execute("help svd info") 381 | return 382 | 383 | try: 384 | periph_name = args[0].upper() 385 | periphs = list(filter(lambda x: x.name.startswith(periph_name), self.device.peripherals)) 386 | regs = fields = None 387 | 388 | if len(args) >= 2: 389 | per = [ per for per in periphs if per.name == periph_name ][0] 390 | reg_name = args[1].upper() 391 | regs = list(filter(lambda x: x.name.startswith(reg_name), per.registers)) 392 | 393 | if len(args) >= 3: 394 | reg = [ reg for reg in regs if reg.name == reg_name ][0] 395 | field_name = args[2].upper() 396 | fields = list(filter(lambda x: x.name.startswith(field_name), reg.fields)) 397 | 398 | GdbSvdCmd.print_desc(self, periphs, regs, fields) 399 | 400 | except: 401 | gdb.write("Error cannot get info\n") 402 | 403 | class GdbSvdDumpCmd(GdbSvdCmd): 404 | """Get register(s) value(s): svd dump [peripheral] 405 | """ 406 | def __init__(self, device, peripherals): 407 | GdbSvdCmd.__init__(self, device, peripherals) 408 | gdb.Command.__init__(self, "svd dump", gdb.COMMAND_DATA) 409 | 410 | def complete(self, text, word): 411 | args = str(text).split(" ") 412 | nb_args = len(args) 413 | 414 | if nb_args == 1: 415 | return gdb.COMPLETE_FILENAME 416 | 417 | if nb_args > 2: 418 | return gdb.COMPLETE_NONE 419 | 420 | # remove first argument 421 | args.pop(0) 422 | 423 | return GdbSvdCmd.complete(self, " ".join(args), word) 424 | 425 | def invoke(self, arg, from_tty): 426 | args = str(arg).split(" ") 427 | if len(args) < 1 or len(args) > 2: 428 | gdb.write("Invalid parameter\n") 429 | gdb.execute("help svd dump") 430 | return 431 | try: 432 | output_file_name = args[0] 433 | gdb.write("Print to file: {}\n".format(output_file_name)) 434 | 435 | if len(args) >= 2: 436 | periph_name = args[1].upper() 437 | periphs = list(filter(lambda x: x.name.startswith(periph_name), self.device.peripherals)) 438 | regs = None 439 | else: 440 | periphs = self.device.peripherals 441 | 442 | try: 443 | file_object = open(output_file_name, "w") 444 | file_object.write("Registers Dump\n") 445 | file_object.close() 446 | for per in periphs: 447 | regs = per.registers 448 | GdbSvdCmd.print_registers(self, per, regs, output_file_name, False) 449 | except: 450 | gdb.write("Error writting to file: {}\n".format(output_file_name)) 451 | except: 452 | gdb.write("Error cannot dump registers\n") 453 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 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 | 294 | Copyright (C) 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 | , 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 | --------------------------------------------------------------------------------