libmaple/examples/test-ring-buffer-insertion.cpp
Marti Bolivar 954f9e5065 Move public headers to include directories; related cleanups.
Move libmaple/*.h to (new) libmaple/include/libmaple/. The new
accepted way to include a libmaple header foo.h is with:

    #include <libmaple/foo.h>

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 <libmaple/foo.h>.
- 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 <libmaple/foo.h>.

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 <board/board.h>

  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 <mbolivar@leaflabs.com>
2012-04-11 16:56:50 -04:00

115 lines
3 KiB
C++

/*
* Simple ring_buffer test.
*
* Does a basic test of functionality on rb_full_count(), rb_reset(),
* rb_push_insert(), and rb_safe_insert().
*
* To test:
*
* - Connect a serial monitor to SerialUSB
* - Press any key
*
* This file is released into the public domain.
*/
#include <wirish/wirish.h>
#include <libmaple/ring_buffer.h>
#define BUF_SIZE 64
ring_buffer ring_buf;
ring_buffer *rb;
uint8 rb_buffer[BUF_SIZE];
void test_rb_push_insert(int num_bytes_to_insert);
void test_rb_safe_insert(int num_bytes_to_insert);
void test_rb_insertion_function(int num_bytes_to_insert,
int (*insertion_fn)(ring_buffer*, uint8),
const char insertion_fn_name[]);
void print_rb_contents(void);
void setup() {
rb = &ring_buf;
rb_init(rb, BUF_SIZE, rb_buffer);
while (!SerialUSB.available())
;
SerialUSB.println("Beginning test.");
SerialUSB.println();
}
void loop() {
test_rb_push_insert(63);
SerialUSB.println("------------------------------");
test_rb_push_insert(64);
SerialUSB.println("------------------------------");
test_rb_safe_insert(63);
SerialUSB.println("------------------------------");
test_rb_safe_insert(64);
SerialUSB.println("------------------------------");
SerialUSB.println();
SerialUSB.println("Test finished.");
while (true)
;
}
void test_rb_push_insert(int num_bytes_to_insert) {
test_rb_insertion_function(num_bytes_to_insert,
rb_push_insert,
"rb_push_insert()");
}
void test_rb_safe_insert(int num_bytes_to_insert) {
test_rb_insertion_function(num_bytes_to_insert,
rb_safe_insert,
"rb_safe_insert()");
}
void test_rb_insertion_function(int num_bytes_to_insert,
int (*insertion_fn)(ring_buffer *, uint8),
const char insertion_fn_name[]) {
SerialUSB.println("resetting ring buffer.");
rb_reset(rb);
print_rb_contents();
SerialUSB.print(insertion_fn_name);
SerialUSB.print("-ing ");
SerialUSB.print(num_bytes_to_insert);
SerialUSB.println(" bytes.");
for (uint8 i = 1; i <= num_bytes_to_insert; i++)
insertion_fn(rb, i);
uint16 count = rb_full_count(rb);
SerialUSB.print("rb_full_count(rb) = ");
SerialUSB.println(count);
print_rb_contents();
}
void print_rb_contents() {
uint16 count = rb_full_count(rb);
SerialUSB.print("ring buffer contents: ");
for (uint16 i = 0; i < count; i++) {
SerialUSB.print((int)rb_remove(rb));
if (i < count - 1) SerialUSB.print(", ");
}
SerialUSB.println();
}
// Force init to be called *first*, i.e. before static object allocation.
// Otherwise, statically allocated objects that need libmaple may fail.
__attribute__((constructor)) void premain() {
init();
}
int main(void) {
setup();
while (true) {
loop();
}
return 0;
}