readme

介绍关于WiMax（IEEE802.16）物理层调制解调编码等相关设计实现

/*************************************************************/
/* README in WiMax-OFDM                                      */
/*                                    Miffie Nov/23/05       */
/*************************************************************/
0). Overview
    This file explains about the contents of the zip file.
    You can expand the contents in Linux with
    unzip wimaxofdm.zip.zip 

    Now You can read this file and find wimaxofdm.zip,
    which is password protected.

  *************************************************************
  * Please read 1) License before unzip wimaxofdm.zip.        *
  * If you can agree with the License ,                       * 
  * please proceed to unzip , otherwise do NOT unzip the file.*
  *************************************************************

    The password is "miffie" for unzip.

    unzip wimaxofdm.zip. 
    This zip file includes a cmodel for 
    a PHY of BASEBAND digital IC of wimax-ofdm

    This model is not fit a verificaion purpose to RTL
    because this takes a lot of 64bit floating point calculations
    which are not efficient for ASIC.
    Also, this cmodel does not have cycle accuracy in Decoder.
    
    But this model may be useful to get some idea to start to
    design a PHY of 11a.  

0-1)  Who's Miffie??
    Miffie is a private engineer who is very intersting in 
   Wireless network system.

1). License

Copyright (c) 2005 miffie   All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this 
list of conditions and the following disclaimer in the documentation and/or 
other materials provided with the distribution.

Neither the name of the "miffie"  nor the names of its contributors may be used 
to endorse or promote products derived from this software without specific prior
written permission.


THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
///////////////////////////////////////////////////////////////////////////////
2). File and Directory

2.1) environment
  ./env/header.h
    Header files list
  ./env/binaryset.c
    Some useful utilities for sets of binarys
  ./env/complex.c
    Some useful utilities for sets of complexs
  ./env/utility.c
    Some useful utilities for random generations
  ./env/files.h
    A file list for Cmodel's comiplation
  ./env/struct.h
    Define some "struct"s

2.2) FEC Encoder
  ./fec/randomizer.c
    8.3.3.1 Randomization
  ./fec/encode_rs.c
    ReedSolomon Encoder of
    8.3.3.2.1 Concatenated Reed-Solomon-convolutional codes
  ./fec/convolution_encoder.c
    Convolution Encoder of
    8.3.3.2.1 Concatenated Reed-Solomon-convolutional codes
  ./fec/turboproduct.c
    8.3.3.2.2 Block Turbo Coding
  ./fec/ctc_encoder.c
    8.3.3.2.3 Convolutional Turbo Codes
  ./fec/interleaver.c
    8.3.3.3 Interleaving
  ./fec/fecenc.c
    8.3.3.2 FEC Encoder  + Randomization wrapper


2.2) FEC Decoder
  ./fec/deinterleaver.c
    Deinterleaver of each OFDM symbol (8.3.3.3 Interleaving)
  ./fec/depuncturing.c
    depuncturing for RS-CC
  ./fec/viterbi_cc.c
    A viterbi Decoder for RS-CC 
  ./fec/decode_rs.c
    Reed-Solomon Decoder
  ./fec/turbo_decoder.c
    Decoder for BTC  
    Turbo Product Decoder
  ./fec/viterbi_turbo1.c
    A viterbi Decoder for BTC to calculate metrics of each checks
  ./fec/viterbi_turbo2.c
    A viterbi Decoder for BTC
  ./fec/ctc_decoder.c
    Decoder for CTC  
    Convolutional Turbo Codes Decoder
  ./fec/viterbi_ctc.c
    A viterbi Decoder for CTC
  ./fec/downlink_fecdec.c
    Downlink FEC wrapper



2.3) OFDM Encoder
  ./ofdm_enc/preamble.c
    8.3.3.6 Preamble structure and modulation
  ./ofdm_enc/mask_sc.c
    OFDM Subcarrier Mask (8.3.2.4 Parametes of transmitted signal)
  ./ofdm_enc/pilot_randomizer.c
    8.3.3.4.2 Pilot modulation
  ./ofdm_enc/mapper.c
    8.3.3.4.1 Data modulation
  ./ofdm_enc/idft256.c
    8.3.2.3 Transmitted signal
  ./ofdm_enc/frameprefix.c
    OFDM downlink frame prefix
  ./ofdm_enc/hcs.c
    Header Check Sequence in downlink frame prefix (8.3.5.1 PMP)
  ./ofdm_enc/frame_enc.c
    Wrapper of 8.3.3 Channel Coding

  ./ofdm_enc/doubler.c
    Oversampling module after Channel Coding
    This may be implemented in DigitalAnalogConverter. 

2.3) OFDM Decoder(Demodulator)
  ./ofdm_dec/pseudo_channel.c
    Emulate Channel between 2 stations & AnalogFrontEnd 
  ./ofdm_dec/detect_drift.c
    Estimate Time domain's Phase drift due to carrier's frequency error.
  ./ofdm_dec/detect_pre.c
    Detect preamble's the second symbol position with first symbol
  ./ofdm_dec/phase_drift.c
    Correct Time domain's Phase drift due to carrier's frequency error.
  ./ofdm_dec/dft64.c
    Descrete Fourier Transform for the first symbol of preamble
  ./ofdm_dec/dft256.c
    Descrete Fourier Transform for a single symbol
  ./ofdm_dec/long_track.c
    Demodulate the second symbol of preamble and initialize each tones' SRAM value
  ./ofdm_dec/equalizer.c
    Demodulate each subcarrier with each tones' SRAM
  ./ofdm_dec/constellation.c
    Demodulate each subcarrier's constellation
  ./ofdm_dec/frame_dec.c
    Decode a frame with a single burst

2.4) Simulation run directory
  ./sim/run
     A cshell executable 
     run all available simulation
  ./sim/main_golden_ppdu.c
     A main routine to test a golden exanple (AnnexG)
  ./sim/golden_ppdu.dat
     A Golden result of AnnexG (Table G.24-The entire packet)
  ./sim/main_ppdutest.c
     A main routine to test a randomly generated PPDU.
  ./sim/ppdu_random.c
     A sub module to test a randomly generated PPDU.
  ./sim/a.out 
     Cmodel's executable. Each "run" generate the file.
     Zipped "a.out" is the one from "./sim/main_ppdutest.c"
  ./sim/ppdu.dat
     Each run of a.out will generate this file 
     to save a entire packet of the generated PPDU.

///////////////////////////////////////////////////////////////////////////////

3) running simulations and Status 
3.1)  running simulations in LINUX
      cd ./sim
      ./run 

      After the ./run finished, please type below: 
      tail log
      
      If you see, "No comparison Error found" , 
      all simulation passed.

3.2)  Status on Nov/23/05
      All of 400 simulations are passed!!
      -No multiple paths has been tested
      -2 Known Encoder problem
       1) Reed-Solomon Encoder output has mimatches from the example of
          8.3.3.5.2 Subchannelization
       2) CTC Encoder
          Table 221-Circulation state lookup table has been changed in this cmodel
          in order to make the last state to zero.
      -As Only a single burst is available in a frame in the current cmodel, 
       All 20 fec_code_type is possible in the first burst. While Only 6 OFDM Rate ID
       are allowed in the WiMaxOFDM spec.
      -Subchannelizations are not tested or not implememted yet.
      -No AAS/Mesh/MISO/STC/UpLink are implemeted yet.
      -Not tested with any realistic reference model

///////////////////////////////////////////////////////////////////////////////

4) References
 - Special Thanks to :
     Get IEEE 802®
     ...Partnering with industry to close the digital divide
     http://standards.ieee.org/getieee802/802.16.html

 - IEEE 802.16
   IEEE standard for Local and metropolitan area networks
   Part 16: Air interface for Fixed Broadband Wireless Access Systems