<feed xmlns='http://www.w3.org/2005/Atom'>
<title>suspect-devices/libmaple/wirish/comm/HardwareSerial.h, branch master</title>
<subtitle>Working copy of Leaflabs libmaple</subtitle>
<id>https://git.suspectdevices.com/suspect-devices/libmaple/atom?h=master</id>
<link rel='self' href='https://git.suspectdevices.com/suspect-devices/libmaple/atom?h=master'/>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/'/>
<updated>2012-04-11T20:56:50+00:00</updated>
<entry>
<title>Move public headers to include directories; related cleanups.</title>
<updated>2012-04-11T20:56:50+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-11-15T17:45:43+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=954f9e5065b39fe4c683f4d216b54326d876f51b'/>
<id>urn:sha1:954f9e5065b39fe4c683f4d216b54326d876f51b</id>
<content type='text'>
Move libmaple/*.h to (new) libmaple/include/libmaple/. The new
accepted way to include a libmaple header foo.h is with:

    #include &lt;libmaple/foo.h&gt;

This is more polite in terms of the include namespace. It also allows
us to e.g. implement the Arduino SPI library at all (which has header
SPI.h; providing it was previously impossible on case-insensitive
filesystems due to libmaple's spi.h).

Similarly for Wirish.

The old include style (#include "header.h") is now deprecated.

libmaple/*.h:

- Change include guard #defines from _FOO_H_ to _LIBMAPLE_FOO_H_.
- Add license headers where they're missing
- Add conditional extern "C" { ... } blocks where they're missing
  (they aren't always necessary, but we might was well do it against
  the future, while we're at it.).
- Change includes from #include "foo.h" to #include &lt;libmaple/foo.h&gt;.
- Move includes after extern "C".
- Remove extra trailing newlines

Note that this doesn't include the headers under libmaple/usb/ or
libmaple/usb/usb_lib. These will get fixed later.

libmaple/*.c:

- Change includes from #include "foo.h" to #include &lt;libmaple/foo.h&gt;.

Makefile:

- Add I$(LIBMAPLE_PATH)/include/libmaple to GLOBAL_FLAGS.  This allows
  for users (including Wirish) to migrate their code, but should go
  away ASAP, since it slows down compilation.

Wirish:

- Move wirish/**/*.h to (new) wirish/include/wirish/.  This ignores
  the USB headers, which, as usual, are getting handled after
  everything else.

- Similarly generify wirish/boards/ structure. For each supported
  board "foo", move wirish/boards/foo.h and wirish/boards/foo.cpp to
  wirish/boards/foo/include/board/board.h and
  wirish/boards/foo/board.cpp, respectively. Also remove the #ifdef
  hacks around the .cpp files.

- wirish/rules.mk: put wirish/boards/foo/include in the include path
  (and add wirish/boards/foo/board.cpp to the list of sources to be
  compiled). This allows saying:

      #include &lt;board/board.h&gt;

  instead of the hack currently in place. We can allow the user to
  override this setting later to make adding custom board definitions
  easier.

- Disable -Werror in libmaple/rules.mk, as the current USB warnings
  don't let the olimex_stm32_h103 board compile. We can re-enable
  -Werror once we've moved the board-specific bits out of libmaple
  proper.

libraries, examples:

- Update includes accordingly.
- Miscellaneous cosmetic fixups.

Signed-off-by: Marti Bolivar &lt;mbolivar@leaflabs.com&gt;
</content>
</entry>
<entry>
<title>HardwareSerial.h: Remove documentation TODO.</title>
<updated>2011-08-16T10:13:48+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-08-16T08:27:15+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=b1b71c5e09c8c1ae0aecb97b8d4843ca0dffbe90'/>
<id>urn:sha1:b1b71c5e09c8c1ae0aecb97b8d4843ca0dffbe90</id>
<content type='text'>
It's difficult to document HardwareSerial's interface fully in
HardwareSerial.h, since most of the methods people care about are
inherited from Print, anyway.  Stick with documenting this interface
by hand for the foreseeable future.
</content>
</entry>
<entry>
<title>HardwareSerial: Add pin accessors.</title>
<updated>2011-08-16T10:13:48+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-08-16T08:15:17+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=fcb4afcd5029702e79185e66c10561d727e04877'/>
<id>urn:sha1:fcb4afcd5029702e79185e66c10561d727e04877</id>
<content type='text'>
</content>
</entry>
<entry>
<title>HardwareSerial: trivial code reordering</title>
<updated>2011-08-16T10:13:48+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-08-16T08:12:47+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=96c474d94baf8a0d56fa8c5b5de23dfd58bb8186'/>
<id>urn:sha1:96c474d94baf8a0d56fa8c5b5de23dfd58bb8186</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Remove reST documentation, attendant updates.</title>
<updated>2011-06-12T00:05:33+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-06-11T23:25:29+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=f36a1d98492fba4c96bde76106aff161a30b389a'/>
<id>urn:sha1:f36a1d98492fba4c96bde76106aff161a30b389a</id>
<content type='text'>
The documentation covers topics not specifically relevant to libmaple,
so it doesn't make sense for it to be part of the libmaple source
distribution.

Delete the docs/ tree, and prepare libmaple for use with the new
leaflabs-docs repo, which will contain the docs from now on.

* README: update to reflect this change

* support/doxygen/Doxyfile: This is the old docs/Doxyfile

* Makefile: Add a doxygen target

* wirish/comm/HardwareSerial.h: fix reference to docs/.  The comment
  informing maintainers that the HardwareSerial interface is
  documented by hand refers to the docs/ tree, which no longer exists.
  Update it to refer to the separate leaflabs-docs repository.

* support/scripts/copy-to-ide: No longer build the documentation
</content>
</entry>
<entry>
<title>Keep it 80-column clean.</title>
<updated>2011-06-07T18:44:39+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-06-07T18:44:39+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=450e1c6e17329525639670855043bb169740702d'/>
<id>urn:sha1:450e1c6e17329525639670855043bb169740702d</id>
<content type='text'>
Go through overlong source code lines and convert as many of them as
appropriate to be 80-column clean.  This mostly affects license
headers.  Overlong lines are determined by running following from the
libmaple base directory:

$ ack-grep --nocolor --nogroup --cpp --cc --ignore-dir=usb -- '.{80}'

Note that this excludes libmaple's usb subdirectory, which is still
full of ST code that doesn't follow the libmaple source code
guidelines.

Contents of ~/.ackrc (these won't matter, but are included for
completeness):

--ignore-dir=docs
--ignore-dir=build
--type-set
ld=.ld
--type-set
rst=.rst
--type-set
txt=.txt
--type-set
mk=.mk
</content>
</entry>
<entry>
<title>HardwareSerial.h: adding documentation TODO for 0.1.0</title>
<updated>2011-05-20T19:21:59+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-05-20T19:21:59+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=3b9cc70fb270b7c49aac23854fd934d95104d26d'/>
<id>urn:sha1:3b9cc70fb270b7c49aac23854fd934d95104d26d</id>
<content type='text'>
</content>
</entry>
<entry>
<title>USART bugfix.</title>
<updated>2011-04-11T19:56:38+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-04-11T19:52:48+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=f604bb7b27abea7e6cab2ef9c5f6d9dde9c69957'/>
<id>urn:sha1:f604bb7b27abea7e6cab2ef9c5f6d9dde9c69957</id>
<content type='text'>
USART refactor commit f6f9a1122706ed336c52c984d76219dee0594487 only
worked for USART1.
</content>
</entry>
<entry>
<title>USART refactor.</title>
<updated>2011-04-07T17:18:36+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-04-06T17:57:30+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=f6f9a1122706ed336c52c984d76219dee0594487'/>
<id>urn:sha1:f6f9a1122706ed336c52c984d76219dee0594487</id>
<content type='text'>
</content>
</entry>
<entry>
<title>Initial timer refactor.</title>
<updated>2011-03-24T11:25:14+00:00</updated>
<author>
<name>Marti Bolivar</name>
<email>mbolivar@leaflabs.com</email>
</author>
<published>2011-03-22T20:59:29+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/libmaple/commit/?id=296b1188bfb8cf28466b95f1dd0fde309b1f9399'/>
<id>urn:sha1:296b1188bfb8cf28466b95f1dd0fde309b1f9399</id>
<content type='text'>
Basic PWM works.  Had some problems in testing that might be due to
USART bugs.

HardwareTimer has been removed from the build for now; I will
re-implement it in terms of the new libmaple API, but consider it
deprecated.  Let's come up with something better.

Servo is implemented in terms of HardwareTimer, so it also has been
temporarily removed from the build.

pwmWrite() likely got a little bit less inefficient due to
indirection, but the PIN_MAPs shrank by a pointer per PinMapping.
</content>
</entry>
</feed>
