API Documentation
5G Toolkit supports wide range of procedures, usecases and features. Some of them are captured directly via the APIs as discussed below in table-1.
Module/Package |
Purpose |
---|---|
Sequence Generation |
Generate all the sequences used for wide variety of purposes in 5G such as channel state acquisition, positioning etc. |
Resource Mapping |
This modules maps various sequences and physical channels payload to the time frequency OFDM grid/resources. |
Physical Channels |
Implements uplink and downlink control, shared and broadcast/random channels. |
Payload Generation |
Generate MIB and DCI payloads, |
Forward Error Correction |
Implements Polar codec, LDPC Codec and Reed Muller Codec for 5G. |
Rate matching |
Supports rate matching for Polar codec, LDPC Codec and Reed Muller Codec. |
Interleavers |
Presents all the Interleavers/Deinterleavers available for various chains in 5G. |
OFDM |
Implements Orthogonal frequency division multiplexing modulator and demodulator. |
Channel processing |
Provides packages for passing a Transmitted signal though the channel in time/frequency domain and adding noise to the input signal based on the SNR. |
Symbol Mapping |
Supports the symbol mapping and symbol demapping to convert the bits to symbols and recovering the llrs/bits from symbols. |
Scrambling |
Implements 5G complaint scrambler and descrambler to randomize the input bits and undo this randomization at receiver. |
CRC |
Implements Cyclic redundancy check encoder and decoder for all the generator polynomial supported by 5G. |
Positioning |
Provides algorithms for delay estimation and position estimation using delay estimates. |
- Sequence Generation
- Primary Synchronization Signal
- Secondary Synchronization Signal
- Demodulation Reference Sequence (DMRS)
- Positioning Reference Sequence (PRS)
- Channel State Information Reference Sequence (CSI-RS)
- Pseudo Random (PN) Sequence
- PUCCH Format 0 Sequence
- PUCCH Format 1 Sequence
- Low PAPR Sequence Type 1
- Sidelink Primary Synchronization Signal
- Sidelink Secondary Synchronization Signal
- Resource Mapping
- Synchronization Signal Block (SSB) Grid Generation
- Synchronization Signal Block (SSB) Resource Mapping
- Physical Downlink Shared Channel-DMRS
- Physical Downlink Shared Channel-PTRS
- Physical Downlink Control Channel (PDCCH)
- Control Resource Set
- Search Space Set
- Channel state Information reference signal (CSI-RS)
- Positioning Reference Signal (PRS)
- Physical Uplink Control Channel (PUCCH)
- Sidelink Synchronization Signal Block (S-SSB) Grid Generation
- Physical Sidelink Control Channel (PSCCH)
- Physical Channels
- Physical Downlink Shared Channel (PDSCH)
- Physical Downlink Control Channel (PDCCH)
- Physical Broadcast Channel (PBCH)
- Physical Uplink Shared Channel (PUSCH)
- Physical Uplink Control Channel (PUCCH)
- Physical Random Access Channel (PRACH)
- Physical Sidelink Control Channel (PSCCH)
- Physical Sidelink Broadcast Channel (PSBCH)
- Payload Generation
- Forward Error Correction
- Rate matching
- Interleavers
- Orthogonal Frequency Division Multiplexing
- Channel Processing and Hardware Impairment
- Symbol Mapping
- Scrambling
- Channel Models
- Cyclic Redundancy Check
- MIMO Processing
- Receiver Algorithms
- Position Estimation
- 5G Configurations
- Utilities