Improved documentation to indicate correspondence to TS38.212 V1.2.1.

Author: robmaunder

PBCH_decoder.m

@@ -1,14 +1,19 @@
 function a_hat = PBCH_decoder(f_tilde, A, L, min_sum, a_tilde)
-% PCBH_DECODER Public Broadcast Channel (PBCH) polar decoder from 3GPP New
-% Radio, as specified in Section 7.1 of TS 38.212 v1.0.1...
-% http://www.3gpp.org/ftp/TSG_RAN/WG1_RL1/TSGR1_AH/NR_AH_1709/Docs/R1-1716928.zip
+% PCBH_DECODER Polar decoder for the Public Broadcast Channel (PBCH) of 3GPP New Radio, as
+% defined in Section 7.1 of TS38.212 V1.2.1. Implements the Cyclic Redudancy
+% Check (CRC) attachment of Section 7.1.3, the channel coding of Section 7.1.4
+% and the rate matching of Section 7.1.5. Note that this code does not
+% implement the payload generation of Section 7.1.1 or the scrambling of
+% Section 7.1.2.
 %   a_hat = PBCH_DECODER(f_tilde, A, L, min_sum, a_tilde) decodes the encoded LLR sequence 
 %   f_tilde, in order to obtain the recovered information bit sequence 
 %   a_hat.
 %
 %   f_tilde should be a real row vector comprising 864 Logarithmic
 %   Likelihood Ratios (LLRS), each having a value obtained as LLR =
-%   ln(P(bit=0)/P(bit=1)).
+%   ln(P(bit=0)/P(bit=1)). The first LLR corresponds to f_0 from Section 
+%   7.1.5 of TS38.212 V1.2.1, while the last LLR corresponds to 
+%   f_E-1.
 %
 %   A should be 32. It specifies the number of bits in the
 %   information bit sequence.
@@ -33,13 +38,14 @@
 %   scrambling of Section 7.1.1 in TS38.212 V1.1.2, since this depends on 
 %   several higher-layer parameters. If scrambling is implemented
 %   externally to this code, then a_tilde should pertain to the scrambled
-%   bit values.
+%   bit values. The first input bit corresponds to a'_0 from 
+%   Section 7.1.3 of TS38.212 V1.2.1, while the last input bit corresponds 
+%   to a'_A-1.
 %
 %   a_hat will be a binary row vector comprising 32 bits, each 
-%   having the value 0 or 1. Note that this code does not perform the 
-%   scrambling of Section 7.1.1 in TS38.212 V1.1.2, since this depends on 
-%   several higher-layer parameters. But scrambling can be implemented
-%   externally to this code.
+%   having the value 0 or 1. The first output bit corresponds to a'_0 from 
+%   Section 7.1.3 of TS38.212 V1.2.1, while the last output bit corresponds 
+%   to a'_A-1.
 %
 %
 %   See also PBCH_ENCODER

PBCH_encoder.m

@@ -1,22 +1,26 @@
 function f = PBCH_encoder(a, E)
-% PBCH_ENCODER Public Broadcast Channel (PBCH) polar encoder from 3GPP New
-% Radio, as specified in Section 7.1 of TS 38.212 v1.0.1...
-% http://www.3gpp.org/ftp/TSG_RAN/WG1_RL1/TSGR1_AH/NR_AH_1709/Docs/R1-1716928.zip
+% PBCH_ENCODER Polar encoder for the Public Broadcast Channel (PBCH) of 3GPP New Radio, as
+% defined in Section 7.1 of TS38.212 V1.2.1. Implements the Cyclic Redudancy
+% Check (CRC) attachment of Section 7.1.3, the channel coding of Section 7.1.4
+% and the rate matching of Section 7.1.5. Note that this code does not
+% implement the payload generation of Section 7.1.1 or the scrambling of
+% Section 7.1.2.
 %   f = PBCH_ENCODER(a, E) encodes the information bit sequence a, in
 %   order to obtain the encoded bit sequence e.
 %
 %   a should be a binary row vector comprising 32 bits, each
-%   having the value 0 or 1. Note that this code does not perform the 
-%   scrambling of Section 7.1.1 in TS38.212 V1.1.2, since this depends on 
-%   several higher-layer parameters. But scrambling can be implemented
-%   externally to this code.
+%   having the value 0 or 1. The first input bit corresponds to a'_0 from 
+%   Section 7.1.3 of TS38.212 V1.2.1, while the last input bit corresponds 
+%   to a'_A-1.
 %
 %   E should be 864. It specifies the number of bits in the
 %   encoded bit sequence. Since there is only one valid value for this 
 %   parameter, it can be omitted.
 %
 %   f will be a binary row vector comprising 864 bits, each having
-%   the value 0 or 1.
+%   the value 0 or 1. The first output bit corresponds to f_0 from Section 
+%   7.1.5 of TS38.212 V1.2.1, while the last output bit corresponds to 
+%   f_E-1.
 %
 %   See also PBCH_DECODER
 %

PDCCH_decoder.m

@@ -1,14 +1,20 @@
 function a_hat = PDCCH_decoder(f_tilde, A, L, min_sum, RNTI)
-% PDCCH_DECODER Physical Downlink Control Channel (PDCCH) polar decoder from 3GPP New
-% Radio, as specified in Section 7.3 of TS 38.212 v1.0.1...
-% http://www.3gpp.org/ftp/TSG_RAN/WG1_RL1/TSGR1_AH/NR_AH_1709/Docs/R1-1716928.zip
+% PDCCH_DECODER Polar decoder for the Physical Downlink Control Channel (PDCCH) of 3GPP New
+% Radio, as defined in Section 7.3 of TS38.212 V1.2.1. Implements the zero-
+% padding to increase the length of short payloads to 12 bits of Section 7.3.1,
+% the Cyclic Redudancy Check (CRC) attachment of Section 7.3.2, the channel
+% coding of Section 7.3.3 and the rate matching of Section 7.3.4. Note that
+% this code does not implement the DCI bit sequence generation of Section
+% 7.3.1.
 %   a_hat = PDCCH_DECODER(f_tilde, A, L, min_sum) decodes the encoded LLR sequence 
 %   f_tilde, in order to obtain the recovered information bit sequence 
 %   a_hat.
 %
 %   f_tilde should be a real row vector comprising E number of Logarithmic
 %   Likelihood Ratios (LLRS), each having a value obtained as LLR =
-%   ln(P(bit=0)/P(bit=1)).
+%   ln(P(bit=0)/P(bit=1)). The first LLR corresponds to f_0 from Section 
+%   7.3.4 of TS38.212 V1.2.1, while the last LLR corresponds to 
+%   f_E-1.
 %
 %   A should be an integer scalar. It specifies the number of bits in the
 %   information bit sequence, where A should be in the range 1 to 140.
@@ -24,10 +30,13 @@
 %
 %   RNTI should be a binary row vector comprising 16 bits, each having the
 %   value 0 or 1. If this parameter is omitted, then ones(1,16) will be
-%   used for the RNTI.
+%   used for the RNTI. The first bit corresponds to x_rnti,0 from Section
+%   7.3.2 of TS38.212 V1.2.1, while the last bit corresponds to x_rnti,15.
 %
 %   a_hat will be a binary row vector comprising A number of bits, each 
-%   having the value 0 or 1.
+%   having the value 0 or 1. The first output bit corresponds to a_0 from 
+%   Section 7.3.1 of TS38.212 V1.2.1, while the last output bit corresponds 
+%   to a_A-1.
 %
 %   See also PDCCH_ENCODER
 %

PDCCH_encoder.m

@@ -1,22 +1,31 @@
 function f = PDCCH_encoder(a, E, RNTI)
-% PDCCH_ENCODER Physical Downlink Control Channel (PDCCH) polar encoder from 3GPP New
-% Radio, as specified in Section 7.3 of TS 38.212 v1.0.1...
-% http://www.3gpp.org/ftp/TSG_RAN/WG1_RL1/TSGR1_AH/NR_AH_1709/Docs/R1-1716928.zip
+% PDCCH_ENCODER Polar encoder for the Physical Downlink Control Channel (PDCCH) of 3GPP New
+% Radio, as defined in Section 7.3 of TS38.212 V1.2.1. Implements the zero-
+% padding to increase the length of short payloads to 12 bits of Section 7.3.1,
+% the Cyclic Redudancy Check (CRC) attachment of Section 7.3.2, the channel
+% coding of Section 7.3.3 and the rate matching of Section 7.3.4. Note that
+% this code does not implement the DCI bit sequence generation of Section
+% 7.3.1.
 %   f = PDCCH_ENCODER(a, E) encodes the information bit sequence a, in
 %   order to obtain the encoded bit sequence e.
 %
 %   a should be a binary row vector comprising A number of bits, each
-%   having the value 0 or 1. A should be in the range 1 to 140.
+%   having the value 0 or 1. A should be in the range 1 to 140. The first
+%   input bit corresponds to a_0 from Section 7.3.1 of TS38.212 V1.2.1, while the
+%   last input bit corresponds to a_A-1.
 %
 %   E should be an integer scalar. It specifies the number of bits in the
 %   encoded bit sequence, where E should greater than A.
 %
 %   RNTI should be a binary row vector comprising 16 bits, each having the
 %   value 0 or 1. If this parameter is omitted, then ones(1,16) will be
-%   used for the RNTI.
+%   used for the RNTI. The first bit corresponds to x_rnti,0 from Section
+%   7.3.2 of TS38.212 V1.2.1, while the last bit corresponds to x_rnti,15.
 %
 %   f will be a binary row vector comprising E number of bits, each having
-%   the value 0 or 1.
+%   the value 0 or 1. The first output bit corresponds to f_0 from Section 
+%   7.3.4 of TS38.212 V1.2.1, while the last output bit corresponds to 
+%   f_E-1.
 %
 %   See also PDCCH_DECODER
 %

PUCCH_decoder.m

@@ -1,14 +1,26 @@
 function a_hat = PUCCH_decoder(f_tilde, A, L, min_sum)
-% PUCCH_DECODER Physical Uplink Control Channel (PUCCH) polar decoder from 3GPP New
-% Radio, as specified in Section 6.3.1 of TS 38.212 v1.1.1
+% PUCCH_DECODER Polar decoder for the Physical Uplink Control Channel (PUCCH) and the
+% Physical Uplink Shared Channel (PUSCH) of 3GPP New Radio, as defined in
+% Section 6.3 of TS38.212 V1.2.1. Implements the code block segmentation and
+% Cyclic Redudancy Check (CRC) attachment of Sections 6.3.1.2.1 and 6.3.2.2.1,
+% the channel coding of Sections 6.3.1.3.1 and 6.3.2.3.2, the rate matching of
+% Sections 6.3.1.4.1 and 6.3.2.4.1, as well as the code block concatenation of
+% Sections 6.3.1.5.1 and 6.3.2.5.1. Note that this code does not implement the
+% UCI bit sequence generation of Sections 6.3.1.1 and 6.3.2.1, the
+% determination of the encoded block length E_UCI of Sections 6.3.1.4.1 and
+% 6.3.2.4.1, or the multiplexing of Sections 6.3.1.6 and 6.3.2.6. Also, this
+% code does not implement the small block lengths, which are detailed in
+% Sections 6.3.1.2.2, 6.3.1.3.2, 6.3.1.4.2, 6.3.2.2.2, 6.3.2.3.2 and 6.3.2.4.2.
 %   a_hat = PUCCH_DECODER(f_tilde, A, L, min_sum) decodes the encoded LLR sequence
 %   f_tilde, in order to obtain the recovered information bit sequence
 %   a_hat.
 %
 %   f_tilde should be a real row vector comprising G number of Logarithmic
 %   Likelihood Ratios (LLRS), each having a value obtained as LLR =
 %   ln(P(bit=0)/P(bit=1)), where G should be no greater than 8192 if A<360
-%   and no greater than 16384 if A>=360.
+%   and no greater than 16384 if A>=360. The first LLR corresponds to g_0 
+%   from Sections 6.3.1.5 and 6.3.2.5 of TS38.212 V1.2.1, while the last 
+%   LLR corresponds to g_G-1.
 %
 %   A should be an integer scalar. It specifies the number of bits in the
 %   information bit sequence, where A should be in the range 12 to 1706.
@@ -23,7 +35,9 @@
 %   complexity.
 %
 %   a_hat will be a binary row vector comprising A number of bits, each
-%   having the value 0 or 1.
+%   having the value 0 or 1. The first output bit corresponds to a_0 from 
+%   Sections 6.3.1.2 and 6.3.2.2 of TS38.212 V1.2.1, while the last output 
+%   bit corresponds to a_A-1.
 %
 %   See also PUCCH_ENCODER
 %

PUCCH_encoder.m

@@ -1,18 +1,32 @@
 function f = PUCCH_encoder(a, G)
-% PUCCH_ENCODER Physical Uplink Control Channel (PUCCH) polar encoder from 3GPP New
-% Radio, as specified in Section 6.3.1 of TS 38.212 v1.1.1
+% PUCCH_ENCODER Polar encoder for the Physical Uplink Control Channel (PUCCH) and the
+% Physical Uplink Shared Channel (PUSCH) of 3GPP New Radio, as defined in
+% Section 6.3 of TS38.212 V1.2.1. Implements the code block segmentation and
+% Cyclic Redudancy Check (CRC) attachment of Sections 6.3.1.2.1 and 6.3.2.2.1,
+% the channel coding of Sections 6.3.1.3.1 and 6.3.2.3.2, the rate matching of
+% Sections 6.3.1.4.1 and 6.3.2.4.1, as well as the code block concatenation of
+% Sections 6.3.1.5.1 and 6.3.2.5.1. Note that this code does not implement the
+% UCI bit sequence generation of Sections 6.3.1.1 and 6.3.2.1, the
+% determination of the encoded block length E_UCI of Sections 6.3.1.4.1 and
+% 6.3.2.4.1, or the multiplexing of Sections 6.3.1.6 and 6.3.2.6. Also, this
+% code does not implement the small block lengths, which are detailed in
+% Sections 6.3.1.2.2, 6.3.1.3.2, 6.3.1.4.2, 6.3.2.2.2, 6.3.2.3.2 and 6.3.2.4.2.
 %   f = PUCCH_ENCODER(a, G) encodes the information bit sequence a, in
 %   order to obtain the encoded bit sequence f.
 %
 %   a should be a binary row vector comprising A number of bits, each
-%   having the value 0 or 1, where A should be in the range 12 to 1706.
+%   having the value 0 or 1, where A should be in the range 12 to 1706. The first
+%   input bit corresponds to a_0 from Sections 6.3.1.2 and 6.3.2.2 of TS38.212
+%   V1.2.1, while the last input bit corresponds to a_A-1.
 %
 %   G should be an integer scalar. It specifies the number of bits in the
 %   encoded bit sequence, where G should be no greater than 8192 if A<360
 %   and no greater than 16384 if A>=360.
 %
 %   f will be a binary row vector comprising G number of bits, each having
-%   the value 0 or 1.
+%   the value 0 or 1. The first output bit corresponds to g_0 from Sections 
+%   6.3.1.5 and 6.3.2.5 of TS38.212 V1.2.1, while the last output bit 
+%   corresponds to g_G-1.
 %
 %   See also PUCCH_DECODER
 %