Changes between Version 28 and Version 29 of HardwareUsersGuides/RadioBoard_v1.4/RadioController

Timestamp:

Mar 19, 2007, 11:22:12 PM (17 years ago)

Author:

sgupta

Comment:

--

HardwareUsersGuides/RadioBoard_v1.4/RadioController

@@ -25 +25 @@
 == Using the Radio Controller Drivers ==
 
-The Radio Controller functions are divided up into five libraries: {{{radio_controller_basic.h}}}, {{{radio_controller_ext.h}}}, {{{radio_controller_adv.h}}}, {{{radio_controller_cal.h}}} and {{{radio_controller_5ghz.h}}}. To use each of the libraries in your C program, include the following line in the beginning of your code:
+The Radio Controller functions are divided up into four libraries: {{{radio_controller_basic.h}}}, {{{radio_controller_ext.h}}}, {{{radio_controller_adv.h}}} and {{{radio_controller_5ghz.h}}}. To use each of the libraries in your C program, include the following line in the beginning of your code:
 {{{
  #include "radio_controller_basic.h"
@@ -42 +42 @@
 {{{radio_controller_5ghz.h}}}
   Has all the functions related to using the 5GHz ISM band that is covered by the radio.
-{{{radio_controller_cal.h}}}
-  Has calibration mode functions.
 
 === Inputs to Functions ===
+
+The inputs to all functions have their descriptions at the beginning of the function calls in the header of the library. One argument to all functions is common:
+
+ {{{radios}}}: This refers to the Radio boards that are to be affected by the function call. Each radio board can be selected by {{{RADIO1_ADDR}}} for the board in slot 1, {{{RADIO2_ADDR}}} for slot 2, etc. To call the function on multiple boards at the same time, OR (|) the values with each other. For example, {{{RADIO1_ADDR|RADIO3_ADDR}}} would affect both the radios in slot 1 and 3.
 
 The following two inputs are common to all functions in the library
@@ -54 +56 @@
 }}}
     If the project has been created with the Base System Builder, generally the base address of the radio controller is XPAR_RADIO_CONTROLLER_0_BASEADDR. Be sure to check this to be certain.
- 1. {{{radios}}}/{{{dacs}}}: This refers to the Radios or the DACs that are to be affected by the function call. Each radio and DAC on the Radio Board can be selected by {{{RADIO1_ADDR}}} or {{{DAC1_ADDR}}} if the Radio Board is in slot 1, {{{RADIO2_ADDR}}} or {{{DAC2_ADDR}}} if in slot 2, etc. To call the function on multiple boards at the same time, OR (|) the values with each other. For example, {{{RADIO1_ADDR|RADIO2_ADDR}}} would affect both the radios in slot 1 and 2.
 
-Any other inputs are explained at the top of that function in {{{radio_controller.h}}}.
 
 === Initialization ===