== GOALS ==
the goals of the project are to reduce the time for security researchers to create needed tools for analyzing unknown targets, to aid in reverse-engineering of hardware, and to satiate my rf lust.

Other requirements:
* python usb
* libusb - should be able to work with either 1.x or 0.1 versions. please let us know if you run into issues.
* pyreadline (especially for Windows)

Build Requirements:
* Make
* SDCC (code is kept up-to-date with the current Ubuntu release, as of this writing: 3.4.0+dfsg-2ubuntu1)

== DEVELOPMENT ==
new development efforts should copy the "application.c" file to "appWhateverMyToolIs.c" and attempt to avoid making changes to other files in the repo if at all possible. that is only a recommendation, because future bug-fixes in other libraries/headers will go much more smoothely for you.

a couple gotchas to keep in mind while developing for the cc1111:
* the memory model includes both "RAM" and "XDATA" concepts, and standard RAM variables and XDATA variables have different assembly instructions that are used to access them. this means that you may find oddities when using a function written for XDATA on a standard RAM variable, and vice-versa.
* variables should be defined in a single .c file, and then "externs" declared in a .h file that can be included in other modules. this is pretty standard for c programs, but both this and the previous point caused me difficulties at some points, and i found myself unsure what was causing my troubles.
* RAM memory is not cheap. use it sparingly.
* you need to set the radio into IDLE mode before reconfiguring it
* you need to set the radio into TX mode before writing to the RFD register (firmware) as it is a 1-byte FIFO.

== INSTALLING HARDWARE==
installing and getting up to speed with rfcat...

first things first. using rfcat requires that you either use the python client in root mode (sudo works well), or configure udev to allow non-root users full access to the dongle. you must also have one of the supported dongles flashed with the necessary application firmware.

We need permanent symlinks to the USB serial devices that will communicate with the CHRONOS, DONSDONGLE or YARDSTICKONE
bootloader when required. If you haven't done this step already (see above), then run:

Next, your user must have read/write access to the dongle when it shows up to the operating system.
For most Linux distros, this means you have to be a member of the "dialout" group.

To prepare your dongle for the first time, you'll need to hook up your debugger as described above and do:

(install 'rfcat_bootloader' from the CC-Bootloader subdirectory to somewhere on your execution path)

cd firmware

for EMK/DONSDONGLE:

make installdonsbootloader

for CHRONOS:

make installchronosbootloader

for YARDSTICKONE:

make installys1bootloader

now unplug the debugger and plug in your USB dongle.

If you have just installed the bootloader, the dongle should be in bootloader mode, indicated by a solid LED.

If you are re-flashing a dongle that is already running rfcat, the Makefile targets will force it into bootloader
mode for you, but you can manually put it into bootloader mode either by holding down the EMK/DONS button as you plug
it into USB (on the CHRONOS or YARDSTICKONE jumper P2_2/DC to GROUND), or by issuing the command 'd.bootloader()' to rfcat in interactive
mode ('rfcat -r'), or by issuing the command 'rfcat --bootloader --force' from the command line.

Once you have a solid LED, or if you're running an rfcat dongle, you can do the following:

cd firmware

for EMK/DONSDONGLE:

make installRfCatDonsDongleCCBootloader

for CHRONOS:

make installRfCatChronosDongleCCBootloader

for YARDSTICKONE:

make installRfCatYS1CCBootloader

The new version will be installed, and bootloader exited.

= INSTALLING - CLIENT-SIDE =
Dependencies: python-usb and libusb

install rfcat onto your system. on most linux systems, this will place rfcat and rfcat_server in /usr/local/bin/ and rflib into /usr/*/lib/python2.x/dist-packages
installation is simple:

cd into the rfcat directory (created by unpacking the tarball or by hg clone)

= USING RFCAT - NON-root MODE =
if you have configured your system to allow non-root use:

type "rfcat -r" (if your system is not configured to allow non-root use, prepend "sudo" or you must run as root)

you should have now entered an interactive python shell, where tab-completion and other aids should make a very powerful experience
i love the raw-byte handling and introspection of it all.

try things like:

d.ping()

d.discover()

d.debug()

d.RFxmit('blahblahblah')

d.RFrecv()

print d.reprRadioConfig()

d.setMdmDRate(19200) # this sets the modem baud rate (or DataRate)

d.setPktPQT(0) # this sets the preamble quality threshold to 0

d.setEnableMdmFEC(True) # enables the convolutional Forward Error Correction built into the radio

while the toolset was created to make communicating with <ghz much easier, you will find the cc1111 manual from ti a great value. the better you understand the radio, the better your experience will be.
play with the radio settings, but i recommend playing in small amounts and watch for the effects. several things in the radio configuration settings are mandatory to get right in order to receive or transmit anything (one of those odd requirements is the TEST2/1/0 registers!)

if you watched any of my talks on rfcat, you will likely remember that you need to put the radio in IDLE state before configuring. (i said it three times, in a row, in different inflections).
however, you will find that i've done that for you in the client for most things. the only time you need to do this yourself are:

if you are doing the changes in firmware

if you are using the "d.poke()" functionality

if you use "d.setRFRegister()", this is handled for you

** use d.setRFRegister() **

== EPILOGUE
other than that, hack fun, and feel free to share any details you can about successes and questions about failures you are able!