From: mmaroti <mmaroti>
Date: Thu, 26 Mar 2009 13:50:15 +0000 (+0000)
Subject: document the RF230 specific configuration options
X-Git-Tag: rc_6_tinyos_2_1_1~444
X-Git-Url: https://oss.titaniummirror.com/gitweb/?p=tinyos-2.x.git;a=commitdiff_plain;h=2dab33bbf8f32f482805802741b6c6f0d7ee3ddf

document the RF230 specific configuration options
---

diff --git a/tos/chips/rf2xx/rf230/README b/tos/chips/rf2xx/rf230/README
new file mode 100644
index 00000000..3ca72722
--- /dev/null
+++ b/tos/chips/rf2xx/rf230/README
@@ -0,0 +1,49 @@
+
+The RF230 radio driver has the following configuration options. Some of 
+these are set in the platforms/xxx/chips/rf230/RadioConfig.h header file. 
+For example see the IRIS platform.
+
+RF230_TRX_CTRL_0_VALUE:
+
+This is the value of the TRX_CTRL_0 register which configures the output 
+pin currents and the CLKM clock:
+
+RF230_CCA_MODE_VALUE:
+
+This is the default value of the CCA_MODE field in the PHY_CC_CCA register
+which is used to configure the default mode of the clear channel assesment
+
+RF230_CCA_THRES_VALUE:
+
+This is the value of the CCA_THRES register that controls the energy levels 
+used for clear channel assesment.
+
+RF230_DEF_RFPOWER:
+
+This is the default value of the TX_PWR field of the PHY_TX_PWR register. 
+This can be cahanged via the PacketTransmitPower interface provided by the 
+RF230ActiveMessageC.
+
+RF230_DEF_CHANNEL:
+
+This is the default value of the CHANNEL field of the PHY_CC_CCA register.
+This can be cahanged via the RadioChannel interface provided by the 
+RF230ActiveMessageC.
+
+RF230_CRCBYTE_COMMAND:
+
+This is the command used to calculate the CRC for the RF230 chip, since it 
+does not support hardware CRC checking (in rev A)
+
+RF230_SLOW_SPI:
+
+Define this if your microcontroller SPI interface is slower then 250 
+kbit/s. This delays the start of transmission to when the header is at 
+least uploaded into the TX buffer.
+
+RF230_RSSI_ENERGY:
+
+If you define this, then the content of the RF230_PHY_ED_LEVEL is queried 
+instead of the RSSI value for eahc incoming message. This value can be 
+obtained with the PacketRSSI interface.
+