aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/usrp/usrp2/fw_common.h
diff options
context:
space:
mode:
Diffstat (limited to 'host/lib/usrp/usrp2/fw_common.h')
-rw-r--r--host/lib/usrp/usrp2/fw_common.h190
1 files changed, 190 insertions, 0 deletions
diff --git a/host/lib/usrp/usrp2/fw_common.h b/host/lib/usrp/usrp2/fw_common.h
new file mode 100644
index 000000000..3def8ddaa
--- /dev/null
+++ b/host/lib/usrp/usrp2/fw_common.h
@@ -0,0 +1,190 @@
+//
+// Copyright 2010 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+//
+
+#ifndef INCLUDED_USRP2_FW_COMMON_H
+#define INCLUDED_USRP2_FW_COMMON_H
+
+/*!
+ * Structs and constants for usrp2 communication.
+ * This header is shared by the firmware and host code.
+ * Therefore, this header may only contain valid C code.
+ */
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// udp ports for the usrp2 communication
+// Dynamic and/or private ports: 49152-65535
+#define USRP2_UDP_CTRL_PORT 49152
+#define USRP2_UDP_DATA_PORT 49153
+
+typedef enum{
+ USRP2_CTRL_ID_HUH_WHAT,
+ //USRP2_CTRL_ID_FOR_SURE, //TODO error condition enums
+ //USRP2_CTRL_ID_SUX_MAN,
+
+ USRP2_CTRL_ID_GIVE_ME_YOUR_IP_ADDR_BRO,
+ USRP2_CTRL_ID_THIS_IS_MY_IP_ADDR_DUDE,
+ USRP2_CTRL_ID_HERE_IS_A_NEW_IP_ADDR_BRO,
+
+ USRP2_CTRL_ID_GIVE_ME_YOUR_MAC_ADDR_BRO,
+ USRP2_CTRL_ID_THIS_IS_MY_MAC_ADDR_DUDE,
+ USRP2_CTRL_ID_HERE_IS_A_NEW_MAC_ADDR_BRO,
+
+ USRP2_CTRL_ID_GIVE_ME_YOUR_DBOARD_IDS_BRO,
+ USRP2_CTRL_ID_THESE_ARE_MY_DBOARD_IDS_DUDE,
+
+ USRP2_CTRL_ID_HERES_A_NEW_CLOCK_CONFIG_BRO,
+ USRP2_CTRL_ID_GOT_THE_NEW_CLOCK_CONFIG_DUDE,
+
+ USRP2_CTRL_ID_USE_THESE_GPIO_DDR_SETTINGS_BRO,
+ USRP2_CTRL_ID_GOT_THE_GPIO_DDR_SETTINGS_DUDE,
+
+ USRP2_CTRL_ID_SET_YOUR_GPIO_PIN_OUTS_BRO,
+ USRP2_CTRL_ID_I_SET_THE_GPIO_PIN_OUTS_DUDE,
+
+ USRP2_CTRL_ID_GIVE_ME_YOUR_GPIO_PIN_VALS_BRO,
+ USRP2_CTRL_ID_HERE_IS_YOUR_GPIO_PIN_VALS_DUDE,
+
+ USRP2_CTRL_ID_USE_THESE_ATR_SETTINGS_BRO,
+ USRP2_CTRL_ID_GOT_THE_ATR_SETTINGS_DUDE,
+
+ USRP2_CTRL_ID_TRANSACT_ME_SOME_SPI_BRO,
+ USRP2_CTRL_ID_OMG_TRANSACTED_SPI_DUDE,
+
+ USRP2_CTRL_ID_DO_AN_I2C_READ_FOR_ME_BRO,
+ USRP2_CTRL_ID_HERES_THE_I2C_DATA_DUDE,
+
+ USRP2_CTRL_ID_WRITE_THESE_I2C_VALUES_BRO,
+ USRP2_CTRL_ID_COOL_IM_DONE_I2C_WRITE_DUDE,
+
+ USRP2_CTRL_ID_WRITE_THIS_TO_THE_AUX_DAC_BRO,
+ USRP2_CTRL_ID_DONE_WITH_THAT_AUX_DAC_DUDE,
+
+ USRP2_CTRL_ID_READ_FROM_THIS_AUX_ADC_BRO,
+ USRP2_CTRL_ID_DONE_WITH_THAT_AUX_ADC_DUDE,
+
+ USRP2_CTRL_ID_SETUP_THIS_DDC_FOR_ME_BRO,
+ USRP2_CTRL_ID_TOTALLY_SETUP_THE_DDC_DUDE,
+
+ USRP2_CTRL_ID_CONFIGURE_STREAMING_FOR_ME_BRO,
+ USRP2_CTRL_ID_CONFIGURED_THAT_STREAMING_DUDE,
+
+ USRP2_CTRL_ID_SETUP_THIS_DUC_FOR_ME_BRO,
+ USRP2_CTRL_ID_TOTALLY_SETUP_THE_DUC_DUDE,
+
+ USRP2_CTRL_ID_PEACE_OUT
+
+} usrp2_ctrl_id_t;
+
+typedef enum{
+ USRP2_PPS_SOURCE_SMA,
+ USRP2_PPS_SOURCE_MIMO
+} usrp2_pps_source_t;
+
+typedef enum{
+ USRP2_PPS_POLARITY_POS,
+ USRP2_PPS_POLARITY_NEG
+} usrp2_pps_polarity_t;
+
+typedef enum{
+ USRP2_REF_SOURCE_INT,
+ USRP2_REF_SOURCE_SMA,
+ USRP2_REF_SOURCE_MIMO
+} usrp2_ref_source_t;
+
+typedef enum{
+ USRP2_DIR_RX,
+ USRP2_DIR_TX
+} usrp2_dir_which_t;
+
+typedef enum{
+ USRP2_CLK_EDGE_RISE,
+ USRP2_CLK_EDGE_FALL
+} usrp2_clk_edge_t;
+
+typedef struct{
+ uint32_t id;
+ uint32_t seq;
+ union{
+ uint32_t ip_addr;
+ uint8_t mac_addr[6];
+ struct {
+ uint16_t rx_id;
+ uint16_t tx_id;
+ } dboard_ids;
+ struct {
+ uint8_t pps_source;
+ uint8_t pps_polarity;
+ uint8_t ref_source;
+ uint8_t _pad;
+ } clock_config;
+ struct {
+ uint8_t bank;
+ uint8_t _pad[3];
+ uint16_t value;
+ uint16_t mask;
+ } gpio_config;
+ struct {
+ uint8_t bank;
+ uint8_t _pad[3];
+ uint16_t tx_value;
+ uint16_t rx_value;
+ uint16_t mask;
+ } atr_config;
+ struct {
+ uint8_t dev;
+ uint8_t latch;
+ uint8_t push;
+ uint8_t readback;
+ uint8_t bytes;
+ uint8_t data[sizeof(uint32_t)];
+ } spi_args;
+ struct {
+ uint8_t addr;
+ uint8_t bytes;
+ uint8_t data[sizeof(uint32_t)];
+ } i2c_args;
+ struct {
+ uint8_t dir;
+ uint8_t which;
+ uint8_t _pad[2];
+ uint32_t value;
+ } aux_args;
+ struct {
+ uint32_t freq_word;
+ uint32_t decim;
+ } ddc_args;
+ struct {
+ uint8_t enabled;
+ uint8_t _pad[3];
+ uint32_t secs;
+ uint32_t ticks;
+ } streaming;
+ struct {
+ uint32_t freq_word;
+ uint32_t interp;
+ uint32_t scale_iq;
+ } duc_args;
+ } data;
+} usrp2_ctrl_data_t;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* INCLUDED_USRP2_FW_COMMON_H */