Changes between Version 9 and Version 10 of warpradio_max2829.c


Ignore:
Timestamp:
Jan 30, 2006, 2:51:52 PM (18 years ago)
Author:
bratton
Comment:

Added 8 descriptions - through the _NoCalibration(...) function

Legend:

Unmodified
Added
Removed
Modified
  • warpradio_max2829.c

    v9 v10  
    77'''References'''
    88[[BR]]''baseaddr'' refers to the base address of the SPI core.
    9 [[BR]]''radbaseaddr'' is base address of the Radio Controller peripheral.
     9[[BR]]''radbaseaddr'' is the base address of the Radio Controller peripheral.
    1010[[BR]]''radios'' is the value applied to the Slave Select Register to select the radios.
    1111
     
    1818
    1919'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L144" void WarpRadio_InitializeRadio(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    20 [[BR]]Initiates the selected radios.  This function must be called at the start of the program and needs to be called only once.  ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral. ''radios'' is the value applied to select the desired radios.
     20[[BR]]Initiates the selected radios.  This function must be called at the start of the program and needs to be called only once.  ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral. ''radios'' is the value applied to select the desired radios.
    2121
    2222
    2323
    2424'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L180" void WarpRadio_RxEnable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    25 [[BR]]Enables the receive mode in the radio board. Forcibly turns off the transmit mode and amplifiers. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral. ''radios'' is the value applied to select the radios to be enabled.
     25[[BR]]Enables the receive mode in the radio board. Forcibly turns off the transmit mode and amplifiers. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral. ''radios'' is the value applied to select the radios to be enabled.
    2626
    2727
    2828
    2929'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L216" void WarpRadio_RxDisable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    30 [[BR]]Disables receive mode in the specified radios. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral. ''radios'' is the value applied to select the desired radios to be disabled.
     30[[BR]]Disables receive mode in the specified radios. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral. ''radios'' is the value applied to select the desired radios to be disabled.
    3131
    3232
    3333
    3434'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L235" void WarpRadio_24AmpEnable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    35 [[BR]]Turns on the 2.4GHz amplifier for the radios selected based on the value applied in ''radios''. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral.
     35[[BR]]Turns on the 2.4GHz amplifier for the radios selected based on the value applied in ''radios''. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    3636
    3737
    3838'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L254" void WarpRadio_24AmpDisable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    39 [[BR]]Turns off the 2.4GHz amplifier for the radios selected based on the value applied in ''radios''. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral.
     39[[BR]]Turns off the 2.4GHz amplifier for the radios selected based on the value applied in ''radios''. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    4040
    4141
    4242'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L276" void WarpRadio_TxEnable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    43 [[BR]]Enables the transmit mode on the Radios specified and turns on the 2.4GHz amplifier. ''radios'' refers to the Radios in the slots whose transmit mode is turned on.
     43[[BR]]Enables the transmit mode on the Radios specified and turns on the 2.4GHz amplifier. ''radios'' refers to the Radios in the slots whose transmit mode is turned on. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    4444[[BR]]'''''This code needs to be checked.  Top-level-comment says 2.4GHz amp is turned on.  In-code-comments say that the 5GHz amp is turned off but do not specify whether the 2.4GHz amp is actually turned on.'''''
    4545
    4646
    4747'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L305" void WarpRadio_TxDisable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    48 [[BR]]Disables the transmit mode on the Radios specified and turns off both amplifiers. ''radios'' refers to the Radios in the slots whose transmit mode is turned off. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral.
     48[[BR]]Disables the transmit mode on the Radios specified and turns off both amplifiers. ''radios'' refers to the Radios in the slots whose transmit mode is turned off. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    4949
    5050
    5151'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L335" void WarpRadio_SHDNEnable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    52 [[BR]]Shuts down the radios specified.  Forcibly turns off transmit and receive modes and shuts down amplifiers. ''radios'' refers to the Radios in the slots affected . ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral.
     52[[BR]]Shuts down the radios specified.  Forcibly turns off transmit and receive modes and shuts down amplifiers. ''radios'' refers to the Radios in the slots affected . ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    5353
    5454
    5555'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L371" void WarpRadio_SHDNDisable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    56 [[BR]]Disable the shutdown mode on the selected radios. ''radios'' refers to the Radios in the slots affected . ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is base address of the Radio Controller peripheral.
     56[[BR]]Disable the shutdown mode on the selected radios. ''radios'' refers to the Radios in the slots affected . ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    5757
    5858
    5959
    6060'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L392" void WarpRadio_Reset(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    61 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     61[[BR]]Reset the radio board registers that are specified in 'radios'. Goes through a set of instructions to achieve a reset of the radios. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    6262
    6363
    6464'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L445" void WarpRadio_RxHpEnable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    65 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     65[[BR]] Enable the RXHP bit in the 'radios' specified. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    6666
    6767
    6868'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L466" void WarpRadio_RxHpDisable(unsigned int* baseaddr, unsigned int* radbaseaddr, unsigned char radios)]'''''
    69 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     69[[BR]] Disable the RXHP bit in the 'radios' specified. ''baseaddr'' refers to the base address of the SPI core. ''radbaseaddr'' is the base address of the Radio Controller peripheral.
    7070
    7171
    7272'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L503" int WarpRadio_SetCenterFreq2GHz(unsigned int* baseaddr, char freqset, unsigned char radios)]'''''
    73 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     73[[BR]] Function used to shift the center frequency within the 2.4GHz band. ''freqset'' defines which frequency to shift to and the shifts are in increments of 5MHz from 2412MHz to 2472 MHz plus one at 2484MHz. ''radios'' signifies for which Radios to adjust the frequency. ''baseaddr'' refers to the base address of the SPI core.
    7474
    7575
    7676'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L683" int WarpRadio_SetCenterFreq5GHz(unsigned int* baseaddr, char freqset, unsigned char radios)]'''''
    77 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     77[[BR]] Function used to shift the center frequency within the 5GHz band. ''freqset'' defines which frequency to shift to and the shifts are in increments of 20MHz from 5180MHz to 5320MHz and 5500Mhz to 5620MHz. ''radios'' signifies for which Radios to adjust the frequency. ''baseaddr'' refers to the base address of the SPI core.
    7878
    7979
    8080'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L998" void WarpRadio_TxCalibration(unsigned int* baseaddr, unsigned char radios)]'''''
    81 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     81[[BR]] Put the radio into transmit calibration mode. 'radios' refers to the radios that will be put into calibration. The affected radios will be forcibly removed from receive calibration mode. ''baseaddr'' refers to the base address of the SPI core.
    8282
    8383
    8484'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L1024" void WarpRadio_RxCalibration(unsigned int* baseaddr, unsigned char radios)]'''''
    85 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     85[[BR]] Put the radio into receive calibration mode. 'radios' refers to the radios that will be put into calibration. The affected radios will be forcibly removed from transmit calibration mode. ''baseaddr'' refers to the base address of the SPI core.
    8686
    8787
    8888'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L1051" void WarpRadio_NoCalibration(unsigned int* baseaddr, unsigned char radios)]'''''
    89 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     89[[BR]] Takes the specified radios out of transmit or receive calibration mode. ''radios'' refers to the Radios in the affected slots.  ''baseaddr'' refers to the base address of the SPI core.
     90
    9091
    9192
    9293'''''[source:"/PlatformSupport/WARP_Libraries/warpradio_max2829.c@latest#L1084" int WarpRadio_TxCalGain(unsigned int* baseaddr, char gain, unsigned char radios)]'''''
    93 [[BR]] '''''DESCRIPTION TO BE ADDED'''''
     94[[BR]]
    9495
    9596