TCP/IP Protocol Suite

Transmitter subcircuit




eth_txethmac.v
`include "timescale.v"


        module eth_txethmac (MTxClk, Reset, TxStartFrm, TxEndFrm, TxUnderRun, TxData, CarrierSense,
                             Collision, Pad, CrcEn, FullD, HugEn, DlyCrcEn, MinFL, MaxFL, IPGT,
                             IPGR1, IPGR2, CollValid, MaxRet, NoBckof, ExDfrEn,
                             MTxD, MTxEn, MTxErr, TxDone, TxRetry, TxAbort, TxUsedData, WillTransmit,
                             ResetCollision, RetryCnt, StartTxDone, StartTxAbort, MaxCollisionOccured,
                             LateCollision, DeferIndication, StatePreamble, StateData

                            );


        input MTxClk;                   // Transmit clock (from PHY)
        input Reset;                    // Reset
        input TxStartFrm;               // Transmit packet start frame
        input TxEndFrm;                 // Transmit packet end frame
        input TxUnderRun;               // Transmit packet under-run
        input [7:0] TxData;             // Transmit packet data byte
        input CarrierSense;             // Carrier sense (synchronized)
        input Collision;                // Collision (synchronized)
        input Pad;                      // Pad enable (from register)
        input CrcEn;                    // Crc enable (from register)
        input FullD;                    // Full duplex (from register)
        input HugEn;                    // Huge packets enable (from register)
        input DlyCrcEn;                 // Delayed Crc enabled (from register)
        input [15:0] MinFL;             // Minimum frame length (from register)
        input [15:0] MaxFL;             // Maximum frame length (from register)
        input [6:0] IPGT;               // Back to back transmit inter packet gap parameter (from register)
        input [6:0] IPGR1;              // Non back to back transmit inter packet gap parameter IPGR1 (from register)
        input [6:0] IPGR2;              // Non back to back transmit inter packet gap parameter IPGR2 (from register)
        input [5:0] CollValid;          // Valid collision window (from register)
        input [3:0] MaxRet;             // Maximum retry number (from register)
        input NoBckof;                  // No backoff (from register)
        input ExDfrEn;                  // Excessive defferal enable (from register)

        output [3:0] MTxD;              // Transmit nibble (to PHY)
        output MTxEn;                   // Transmit enable (to PHY)
        output MTxErr;                  // Transmit error (to PHY)
        output TxDone;                  // Transmit packet done (to RISC)
        output TxRetry;                 // Transmit packet retry (to RISC)
        output TxAbort;                 // Transmit packet abort (to RISC)
        output TxUsedData;              // Transmit packet used data (to RISC)
        output WillTransmit;            // Will transmit (to RxEthMAC)
        output ResetCollision;          // Reset Collision (for synchronizing collision)
        output [3:0] RetryCnt;          // Latched Retry Counter for tx status purposes
        output StartTxDone;
        output StartTxAbort;
        output MaxCollisionOccured;
        output LateCollision;
        output DeferIndication;
        output StatePreamble;
        output [1:0] StateData;

        reg [3:0] MTxD;
        reg MTxEn;
        reg MTxErr;
        reg TxDone;
        reg TxRetry;
        reg TxAbort;
        reg TxUsedData;
        reg WillTransmit;
        reg ColWindow;
        reg StopExcessiveDeferOccured;
        reg [3:0] RetryCnt;
        reg [3:0] MTxD_d;
        reg StatusLatch;
        reg PacketFinished_q;
        reg PacketFinished;


        wire ExcessiveDeferOccured;
        wire StartIPG;
        wire StartPreamble;
        wire [1:0] StartData;
        wire StartFCS;
        wire StartJam;
        wire StartDefer;
        wire StartBackoff;
        wire StateDefer;
        wire StateIPG;
        wire StateIdle;
        wire StatePAD;
        wire StateFCS;
        wire StateJam;
        wire StateJam_q;
        wire StateBackOff;
        wire StateSFD;
        wire StartTxRetry;
        wire UnderRun;
        wire TooBig;
        wire [31:0] Crc;
        wire CrcError;
        wire [2:0] DlyCrcCnt;
        wire [15:0] NibCnt;
        wire NibCntEq7;
        wire NibCntEq15;
        wire NibbleMinFl;
        wire ExcessiveDefer;
        wire [15:0] ByteCnt;
        wire MaxFrame;
        wire RetryMax;
        wire RandomEq0;
        wire RandomEqByteCnt;
        wire PacketFinished_d;



        assign ResetCollision = ~(StatePreamble | (|StateData) | StatePAD | StateFCS);

        assign ExcessiveDeferOccured = TxStartFrm & StateDefer & ExcessiveDefer & ~StopExcessiveDeferOccured;

        assign StartTxDone = ~Collision & (StateFCS & NibCntEq7 | StateData[1] & TxEndFrm & (~Pad | Pad & NibbleMinFl) & ~CrcEn);

        assign UnderRun = StateData[0] & TxUnderRun & ~Collision;

        assign TooBig = ~Collision & MaxFrame & (StateData[0] & ~TxUnderRun | StateFCS);

        // assign StartTxRetry = StartJam & (ColWindow & ~RetryMax);
        assign StartTxRetry = StartJam & (ColWindow & ~RetryMax) & ~UnderRun;

        assign LateCollision = StartJam & ~ColWindow & ~UnderRun;

        assign MaxCollisionOccured = StartJam & ColWindow & RetryMax;

        assign StateSFD = StatePreamble & NibCntEq15;

        assign StartTxAbort = TooBig | UnderRun | ExcessiveDeferOccured | LateCollision | MaxCollisionOccured;


        // StopExcessiveDeferOccured
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            StopExcessiveDeferOccured <=  1'b0;
          else
            begin
              if(~TxStartFrm)
                StopExcessiveDeferOccured <=  1'b0;
              else
              if(ExcessiveDeferOccured)
                StopExcessiveDeferOccured <=  1'b1;
            end
        end


        // Collision Window
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            ColWindow <=  1'b1;
          else
            begin
              if(~Collision & ByteCnt[5:0] == CollValid[5:0] & (StateData[1] | StatePAD & NibCnt[0] | StateFCS & NibCnt[0]))
                ColWindow <=  1'b0;
              else
              if(StateIdle | StateIPG)
                ColWindow <=  1'b1;
            end
        end


        // Start Window
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            StatusLatch <=  1'b0;
          else
            begin
              if(~TxStartFrm)
                StatusLatch <=  1'b0;
              else
              if(ExcessiveDeferOccured | StateIdle)
                StatusLatch <=  1'b1;
             end
        end


        // Transmit packet used data
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            TxUsedData <=  1'b0;
          else
            TxUsedData <=  |StartData;
        end


        // Transmit packet done
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            TxDone <=  1'b0;
          else
            begin
              if(TxStartFrm & ~StatusLatch)
                TxDone <=  1'b0;
              else
              if(StartTxDone)
                TxDone <=  1'b1;
            end
        end


        // Transmit packet retry
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            TxRetry <=  1'b0;
          else
            begin
              if(TxStartFrm & ~StatusLatch)
                TxRetry <=  1'b0;
              else
              if(StartTxRetry)
                TxRetry <=  1'b1;
             end
        end


        // Transmit packet abort
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            TxAbort <=  1'b0;
          else
            begin
              if(TxStartFrm & ~StatusLatch & ~ExcessiveDeferOccured)
                TxAbort <=  1'b0;
              else
              if(StartTxAbort)
                TxAbort <=  1'b1;
            end
        end


        // Retry counter
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            RetryCnt[3:0] <=  4'h0;
          else
            begin
              if(ExcessiveDeferOccured | UnderRun | TooBig | StartTxDone | TxUnderRun
                  | StateJam & NibCntEq7 & (~ColWindow | RetryMax))
                RetryCnt[3:0] <=  4'h0;
              else
              if(StateJam & NibCntEq7 & ColWindow & (RandomEq0 | NoBckof) | StateBackOff & RandomEqByteCnt)
                RetryCnt[3:0] <=  RetryCnt[3:0] + 1;
            end
        end


        assign RetryMax = RetryCnt[3:0] == MaxRet[3:0];


        // Transmit nibble
        always @ (StatePreamble or StateData or StateData or StateFCS or StateJam or StateSFD or TxData or
                  Crc or NibCntEq15)
        begin
          if(StateData[0])
            MTxD_d[3:0] = TxData[3:0];                                  // Lower nibble
          else
          if(StateData[1])
            MTxD_d[3:0] = TxData[7:4];                                  // Higher nibble
          else
          if(StateFCS)
            MTxD_d[3:0] = {~Crc[28], ~Crc[29], ~Crc[30], ~Crc[31]};     // Crc
          else
          if(StateJam)
            MTxD_d[3:0] = 4'h9;                                         // Jam pattern
          else
          if(StatePreamble)
            if(NibCntEq15)
              MTxD_d[3:0] = 4'hd;                                       // SFD
            else
              MTxD_d[3:0] = 4'h5;                                       // Preamble
          else
            MTxD_d[3:0] = 4'h0;
        end


        // Transmit Enable
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            MTxEn <=  1'b0;
          else
            MTxEn <=  StatePreamble | (|StateData) | StatePAD | StateFCS | StateJam;
        end


        // Transmit nibble
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            MTxD[3:0] <=  4'h0;
          else
            MTxD[3:0] <=  MTxD_d[3:0];
        end


        // Transmit error
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            MTxErr <=  1'b0;
          else
            MTxErr <=  TooBig | UnderRun;
        end


        // WillTransmit
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            WillTransmit <=   1'b0;
          else
            WillTransmit <=  StartPreamble | StatePreamble | (|StateData) | StatePAD | StateFCS | StateJam;
        end


        assign PacketFinished_d = StartTxDone | TooBig | UnderRun | LateCollision | MaxCollisionOccured | ExcessiveDeferOccured;


        // Packet finished
        always @ (posedge MTxClk or posedge Reset)
        begin
          if(Reset)
            begin
              PacketFinished <=  1'b0;
              PacketFinished_q  <=  1'b0;
            end
          else
            begin
              PacketFinished <=  PacketFinished_d;
              PacketFinished_q  <=  PacketFinished;
            end
        end


        // Connecting module Counters
        eth_txcounters txcounters1 (.StatePreamble(StatePreamble), .StateIPG(StateIPG), .StateData(StateData),
                                    .StatePAD(StatePAD), .StateFCS(StateFCS), .StateJam(StateJam), .StateBackOff(StateBackOff),
                                    .StateDefer(StateDefer), .StateIdle(StateIdle), .StartDefer(StartDefer), .StartIPG(StartIPG),
                                    .StartFCS(StartFCS), .StartJam(StartJam), .TxStartFrm(TxStartFrm), .MTxClk(MTxClk),
                                    .Reset(Reset), .MinFL(MinFL), .MaxFL(MaxFL), .HugEn(HugEn), .ExDfrEn(ExDfrEn),
                                    .PacketFinished_q(PacketFinished_q), .DlyCrcEn(DlyCrcEn), .StartBackoff(StartBackoff),
                                    .StateSFD(StateSFD), .ByteCnt(ByteCnt), .NibCnt(NibCnt), .ExcessiveDefer(ExcessiveDefer),
                                    .NibCntEq7(NibCntEq7), .NibCntEq15(NibCntEq15), .MaxFrame(MaxFrame), .NibbleMinFl(NibbleMinFl),
                                    .DlyCrcCnt(DlyCrcCnt)
                                   );


        // Connecting module StateM
        eth_txstatem txstatem1 (.MTxClk(MTxClk), .Reset(Reset), .ExcessiveDefer(ExcessiveDefer), .CarrierSense(CarrierSense),
                                .NibCnt(NibCnt[6:0]), .IPGT(IPGT), .IPGR1(IPGR1), .IPGR2(IPGR2), .FullD(FullD),
                                .TxStartFrm(TxStartFrm), .TxEndFrm(TxEndFrm), .TxUnderRun(TxUnderRun), .Collision(Collision),
                                .UnderRun(UnderRun), .StartTxDone(StartTxDone), .TooBig(TooBig), .NibCntEq7(NibCntEq7),
                                .NibCntEq15(NibCntEq15), .MaxFrame(MaxFrame), .Pad(Pad), .CrcEn(CrcEn),
                                .NibbleMinFl(NibbleMinFl), .RandomEq0(RandomEq0), .ColWindow(ColWindow), .RetryMax(RetryMax),
                                .NoBckof(NoBckof), .RandomEqByteCnt(RandomEqByteCnt), .StateIdle(StateIdle),
                                .StateIPG(StateIPG), .StatePreamble(StatePreamble), .StateData(StateData), .StatePAD(StatePAD),
                                .StateFCS(StateFCS), .StateJam(StateJam), .StateJam_q(StateJam_q), .StateBackOff(StateBackOff),
                                .StateDefer(StateDefer), .StartFCS(StartFCS), .StartJam(StartJam), .StartBackoff(StartBackoff),
                                .StartDefer(StartDefer), .DeferIndication(DeferIndication), .StartPreamble(StartPreamble), .StartData(StartData), .StartIPG(StartIPG)
                               );


        wire Enable_Crc;
        wire [3:0] Data_Crc;
        wire Initialize_Crc;

        assign Enable_Crc = ~StateFCS;

        assign Data_Crc[0] = StateData[0]? TxData[3] : StateData[1]? TxData[7] : 1'b0;
        assign Data_Crc[1] = StateData[0]? TxData[2] : StateData[1]? TxData[6] : 1'b0;
        assign Data_Crc[2] = StateData[0]? TxData[1] : StateData[1]? TxData[5] : 1'b0;
        assign Data_Crc[3] = StateData[0]? TxData[0] : StateData[1]? TxData[4] : 1'b0;

        assign Initialize_Crc = StateIdle | StatePreamble | (|DlyCrcCnt);


        // Connecting module Crc
        eth_crc txcrc (.Clk(MTxClk), .Reset(Reset), .Data(Data_Crc), .Enable(Enable_Crc), .Initialize(Initialize_Crc),
                       .Crc(Crc), .CrcError(CrcError)
                      );


        // Connecting module Random
        eth_random random1 (.MTxClk(MTxClk), .Reset(Reset), .StateJam(StateJam), .StateJam_q(StateJam_q), .RetryCnt(RetryCnt),
                            .NibCnt(NibCnt), .ByteCnt(ByteCnt[9:0]), .RandomEq0(RandomEq0), .RandomEqByteCnt(RandomEqByteCnt));




        endmodule