Permalink
Browse files

Add some basic documentation and a copyright for folks that are curious.

  • Loading branch information...
1 parent 9237f20 commit 7d4158f9d0f7d4694e67c376caab3eaf06984763 Mike Smith committed Nov 3, 2011
Showing with 86 additions and 0 deletions.
  1. +24 −0 COPYING
  2. +62 −0 README.markdown
View
24 COPYING
@@ -0,0 +1,24 @@
+ Copyright (c) 2011 Michael Smith, All Rights Reserved
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ o Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ o Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -0,0 +1,62 @@
+# SiK - Firmware for SiLabs Si1000 ISM radios
+
+SiK is a collection of firmware and tools for radios based on the cheap, versatile SiLabs Si1000 SoC.
+
+Currently, it supports the following boards:
+
+ - HopeRF HM-TRP
+ - HopeRF RF50-DEMO
+
+Adding support for additional boards should not be difficult.
+
+Currently the firmware components include:
+
+ - A bootloader with support for firmware upgrades over the serial interface.
+ - Radio firmware with support for parsing AT commands, storing parameters and basic radio initialisation.
+
+In the short term, the radio firmware will be expanded to do simple transparent serial data exchange, but longer term plans include link reliability and proper link scheduling.
+
+## What You Will Need
+
+ - A Mac OS X or Linux system for building. Mac users will need the Developer Tools (Xcode) installed.
+ - At least two Si1000-based radio devices (just one radio by itself is not very useful).
+ - A [SiLabs USB debug adapter](http://www.silabs.com/products/mcu/Pages/USBDebug.aspx).
+ - [SDCC](http://sdcc.sourceforge.net/), version 3.0 or later.
+ - [EC2Tools](http://github.com/MikeSmith/ec2-new)
+ - [Mono](http://www.mono-project.com/) to build and run the firmware updater.
+
+Note that at this time, building on Windows systems is not supported. If someone wants to contribute and maintain the necessary pieces that would be wonderful.
+
+## Building Things
+
+Type `make install` in the Firmware directory. If all is well, this will produce a folder called `dst` containing bootloader and firmware images.
+
+If you want to fine-tune the build process, `make help` will give you more details.
+
+Building the SiK firmware generates bootloaders and firmware for each of the supported boards. Many boards are available tuned to specific frequencies, but have no way for software on the Si1000 to detect which frequency the board is configured for. In this case, the build will produce different versions of the bootloader for each board. It's important to select the correct bootloader version for your board if this is the case.
+
+## Flashing and Uploading
+
+The SiLabs debug adapter can be used to flash both the bootloader and the firmware. Alternatively, once the bootloader has been flashed the updater application can be used to update the firmware (it's faster than flashing, too).
+
+The `Firmware/tools/upload` script can be used to flash either a bootloader or firmware to an attached board with the SiLabs USB debug adapter.
+
+To use the updater application, open the `SiKUploader/SikUploader.sln` Mono solution file, build and run the application. Select the serial port connected to your radio and the appropriate firmware `.hex` file for the firmware you wish to uploader.
+
+The uploader application contains a bidirectional serial console that can be used for interacting with the radio firmware.
+
+## Supporting New Boards
+
+Take a look at `Firmware/include/board_*.h` for the details of what board support entails. It will help to have a schematic for your board, and in the worst case, you may need to experiment a little to determine a suitable value for EZRADIOPRO_OSC_CAP_VALUE. To set the frequency codes for your board, edit the corresponding `Firmware/include/rules_*.mk` file.
+
+## Resources
+
+SiLabs have an extensive collection of documentation, application notes and sample code available online. Start at the [Si1000 product page](http://www.silabs.com/products/wireless/wirelessmcu/Pages/Si1000.aspx)
+
+## Reporting Problems
+
+Please use the GitHub issues link at the top of the [project page](http://github.com/MikeSmith/SiK) to report any problems with, or to make suggestions about SiK. I encourage you to fork the project and make whatever use you may of it.
+
+## What does SiK mean?
+
+It should really be Sik, since 'K' is the SI abbreviation for Kelvin, and what I meant was 'k', i.e. 1000. Someday I might change it.

0 comments on commit 7d4158f

Please sign in to comment.