Skip to content

Commit f1df6c0

Browse files
author
cederom
committed
added autotools integration.
git-svn-id: https://libswd.svn.sourceforge.net/svnroot/libswd/trunk@15 c3efbdc8-ab98-4870-8aff-218f92231fbf
1 parent 2b6c8f5 commit f1df6c0

File tree

107 files changed

+476
-3446
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+476
-3446
lines changed

libswd/COPYING

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Serial Wire Debug Open Library is distributed under 3-clause BSD license.
2+
3+
Copyright (C) 2010-2011, Tomasz Boleslaw CEDRO (http://www.tomek.cedro.info)
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
1. Redistributions of source code must retain the above copyright notice,
9+
this list of conditions and the following disclaimer.
10+
2. Redistributions in binary form must reproduce the above copyright notice,
11+
this list of conditions and the following disclaimer in the documentation
12+
and/or other materials provided with the distribution.
13+
3. Neither the name of the Tomasz Boleslaw CEDRO nor the names of its
14+
contributors may be used to endorse or promote products derived from this
15+
software without specific prior written permission.
16+
17+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
21+
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
22+
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25+
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27+
OF THE POSSIBILITY OF SUCH DAMAGE.*
28+
29+
Written by Tomasz Boleslaw CEDRO <[email protected]>, 2010-2011;

libswd/ChangeLog

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
LibSWD-0.1 (2011-04-02):
3+
Initial release of LibSWD:
4+
* Basic functionality of transport, queue and drivers for ADIv5.0.
5+
* Automated SW-DP activation/reset and IDCODE read.
6+
* Tested and verified functionality on UrJTAG.
7+
* Source code documented using Doxygen.
8+
* Autotools integration for standarized build.
9+
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Doxyfile 1.7.1
22
DOXYFILE_ENCODING = UTF-8
3-
PROJECT_NAME = libswd
4-
PROJECT_NUMBER = 0.0.1
5-
OUTPUT_DIRECTORY = ../doc
3+
PROJECT_NAME = "Serial Wire Debug Open Library"
4+
PROJECT_NUMBER = $(PROJECT)-$(VERSION)
5+
OUTPUT_DIRECTORY = doxygen-doc
66
CREATE_SUBDIRS = NO
77

88
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
@@ -537,7 +537,8 @@ WARN_LOGFILE =
537537
# directories like "/usr/src/myproject". Separate the files or directories
538538
# with spaces.
539539

540-
INPUT = libswd.h libswd.c libswd_drv_dummy.c
540+
#INPUT = libswd.h libswd.c libswd_drv_dummy.c
541+
INPUT = src/
541542

542543
# This tag can be used to specify the character encoding of the source files
543544
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -1169,7 +1170,7 @@ RTF_EXTENSIONS_FILE =
11691170
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
11701171
# generate man pages
11711172

1172-
GENERATE_MAN = YES
1173+
GENERATE_MAN = NO
11731174

11741175
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
11751176
# If a relative path is entered the value of OUTPUT_DIRECTORY will be

libswd/Makefile.am

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
include $(top_srcdir)/aminclude.am
2+
SUBDIRS = src
3+
ACLOCAL_AMFLAGS = -I m4
4+
nobase_dist_pkgdata_DATA = doc/libswd-0.1.pdf

libswd/NEWS

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2011-04-02:
2+
-----------
3+
* LibSWD initial version 0.1 released to the public.
4+
5+
2011-03-23:
6+
-----------
7+
* Integration with UrJTAG complete. Source code sent to developers.
8+
* Functionality verification complete. Updated work in progress description
9+
at http://stm32primer2swd.sourceforge.net/
10+
11+
2011-02-09:
12+
-----------
13+
* Remote source code repository (SVN) started.
14+
15+
2010-12-29:
16+
-----------
17+
* Official LibSWD project website launched at http://libswd.sf.net
18+
19+
2010-11-23:
20+
-----------
21+
* Decision to implement SWD API as standalone library.
22+
23+
2010-10-21:
24+
-----------
25+
* Work to create open swd implementation has begun.
26+
* Website with progress log launched at http://stm32primer2swd.sourceforge.net/.

libswd/README

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Serial Wire Debug Open Library Readme File
2+
3+
1. General information.
4+
2. How to build and install.
5+
6+
----------------------
7+
1. General information
8+
9+
Serial Wire Debug Open Library is first open solution for accessing the SW-DP (Serial Wire Debug Port) on ARM Cortex CPU based embedded systems. Library is available under "new" 3 clause BSD License. This project was started by Tomek Cedro to create and document Free and Open-Source SWD (Serial Wire Debug) access to new ARM-Cortex CPU cores. SWD is an alternative to JTAG method for accessing the DAP that allows low-level access to system resources such as system bus, memory, IO, even single stepping the code execution - a must-have for an embedded systems developer.
10+
11+
SWD works on both simple and advanced devices from the ARM Cortex family. By default Cortex CPU or FPGA'a IP Core is both JTAG and SWD capable, so the common name for this transport method is SWJ (Serial Wire and JTAG). It is the application requirement and designer choice if a final product supports JTAG, SWD, or both (SWJ).
12+
13+
LibSWD can be considered almost standalone to be easily integrated into third party software with minimal impact on existing program structure. LibSWD implements all utilities necessary to generate bit stream and queue bus operations on both high (operation) and low (bit) abstraction level. High level functions can be called from external application to generate queue that represent bus operations or simply produce a bitstream that can be later flushed into real hardware with simple set of functions (these functions can utilise existing cable drivers already implemented in external software).
14+
15+
The first approach and practical tests were performed on simple STM32Primer development kits using UrJTAG and OpenOCD utilities as described on the http://stm32primer2.sf.net project webstie. Major parts of this research were conducted as a cooperation between Orange Labs Warsaw and Orange Labs Paris, and some additionally by Cybernetic Research Student Group from Warsaw University of Technology in Poland that I am founder and member.
16+
17+
For more information please visit project website at http://libswd.sf.net.
18+
19+
20+
----------------------------
21+
2. How to build and install.
22+
23+
To obtain the latest release visit project website at http://libswd.sf.net. LibSWD use Autotools so the build and install procedure is pretty straightforward:
24+
25+
tar xjvf libswd-<version>.tar.bz2
26+
cd libswd-<version>
27+
./configure <optional parameters>
28+
make install clean
29+
30+
It is possible to build the documentation in html, pdf or both formats. Note that you need to have Doxygen installed for this to work. Additionally you need to have LaTeX installed to build the PDF.
31+
32+
make doxygen-pdf
33+
make doxygen-html
34+
make doxygen-doc
35+
36+
To create package file for distribution type:
37+
38+
make distcheck
39+
40+
To uninstall the library type:
41+
42+
make uninstall
43+

0 commit comments

Comments
 (0)