length_delay_calculation.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PCBNEW_LENGTH_DELAY_CALCULATION_H
#define PCBNEW_LENGTH_DELAY_CALCULATION_H
 
#include "tuning_profile_parameters_iface.h"
#include "tuning_profile_parameters_user_defined.h"
 
#include <board_design_settings.h>
#include <connectivity/connectivity_data.h>
#include <length_delay_calculation/length_delay_calculation_item.h>
#include <unordered_set>
 
class BOARD;
class PCB_VIA;

struct LENGTH_DELAY_STATS
{
    // Generic statistics
    int NumPads{ 0 };
    int NumVias{ 0 };
 
    // Space domain statistics
    int                                              ViaLength{ 0 };
    int64_t                                          TrackLength{ 0 };
    int                                              PadToDieLength{ 0 };
    std::unique_ptr<std::map<PCB_LAYER_ID, int64_t>> LayerLengths;

    int64_t TotalLength() const { return ViaLength + TrackLength + PadToDieLength; }
 
    // Time domain statistics
    int64_t                                          ViaDelay{ 0 };
    int64_t                                          TrackDelay{ 0 };
    int64_t                                          PadToDieDelay{ 0 };
    std::unique_ptr<std::map<PCB_LAYER_ID, int64_t>> LayerDelays;

    int64_t TotalDelay() const { return ViaDelay + TrackDelay + PadToDieDelay; }
};
 

struct PATH_OPTIMISATIONS
{
    bool OptimiseVias = false;

    bool MergeTracks = false;

    bool OptimiseTracesInPads = false;

    bool InferViaInPad = false;
};
 

enum class LENGTH_DELAY_LAYER_OPT
{
    NO_LAYER_DETAIL,
    WITH_LAYER_DETAIL
};
 

enum class LENGTH_DELAY_DOMAIN_OPT
{
    NO_DELAY_DETAIL,
    WITH_DELAY_DETAIL
};
 

struct LENGTH_DELAY_ITEM_DETAILS
{
    std::vector<std::pair<int64_t, int64_t>> LengthsAndDelays;

    int64_t InferredStartViaLength{ 0 };

    int64_t InferredEndViaLength{ 0 };

    int64_t InferredStartViaDelay{ 0 };

    int64_t InferredEndViaDelay{ 0 };
};
 

class LENGTH_DELAY_CALCULATION
{
public:
    explicit LENGTH_DELAY_CALCULATION( BOARD* aBoard ) :
            m_board( aBoard ),
            m_tuningProfileParameters( std::make_unique<TUNING_PROFILE_PARAMETERS_USER_DEFINED>( aBoard, this ) )
    {
    }

    int64_t CalculateLength( std::vector<LENGTH_DELAY_CALCULATION_ITEM>& aItems, PATH_OPTIMISATIONS aOptimisations,
                             const PAD* aStartPad = nullptr, const PAD* aEndPad = nullptr ) const;

    int64_t CalculateDelay( std::vector<LENGTH_DELAY_CALCULATION_ITEM>& aItems, PATH_OPTIMISATIONS aOptimisations,
                            const PAD* aStartPad = nullptr, const PAD* aEndPad = nullptr ) const;

    LENGTH_DELAY_STATS
    CalculateLengthDetails( std::vector<LENGTH_DELAY_CALCULATION_ITEM>& aItems, PATH_OPTIMISATIONS aOptimisations,
                            const PAD* aStartPad = nullptr, const PAD* aEndPad = nullptr,
                            LENGTH_DELAY_LAYER_OPT     aLayerOpt = LENGTH_DELAY_LAYER_OPT::NO_LAYER_DETAIL,
                            LENGTH_DELAY_DOMAIN_OPT    aDomain = LENGTH_DELAY_DOMAIN_OPT::NO_DELAY_DETAIL,
                            LENGTH_DELAY_ITEM_DETAILS* aPerItemLengthDelays = nullptr ) const;

    int64_t CalculatePropagationDelayForShapeLineChain( const SHAPE_LINE_CHAIN&                aShape,
                                                        const TUNING_PROFILE_GEOMETRY_CONTEXT& aCtx ) const;

    int64_t CalculateLengthForDelay( int64_t aDesiredDelay, const TUNING_PROFILE_GEOMETRY_CONTEXT& aCtx ) const;

    static void OptimiseTraceInPad( SHAPE_LINE_CHAIN& aLine, const PAD* aPad, PCB_LAYER_ID aPcbLayer );

    static bool IsPointInsideViaPad( const PCB_VIA* aVia, const VECTOR2I& aPoint, PCB_LAYER_ID aLayer );

    static void OptimiseTraceInVia( SHAPE_LINE_CHAIN& aLine, const PCB_VIA* aVia, PCB_LAYER_ID aLayer );

    LENGTH_DELAY_CALCULATION_ITEM GetLengthCalculationItem( const BOARD_CONNECTED_ITEM* aBoardItem ) const;

    void SetTuningProfileParametersProvider( std::unique_ptr<TUNING_PROFILE_PARAMETERS_IFACE>&& aProvider );

    void SynchronizeTuningProfileProperties() const;

    int StackupHeight( PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer ) const;
 
protected:
    BOARD* m_board;

    std::unique_ptr<TUNING_PROFILE_PARAMETERS_IFACE> m_tuningProfileParameters;

    enum class MERGE_POINT
    {
        START,
        END
    };

    static void optimiseTracesInPads( const std::vector<LENGTH_DELAY_CALCULATION_ITEM*>& aPads,
                                      const std::vector<LENGTH_DELAY_CALCULATION_ITEM*>& aLines );

    static void clipLineToPad( SHAPE_LINE_CHAIN& aLine, const PAD* aPad, PCB_LAYER_ID aLayer, bool aForward = true );

    static void clipLineToVia( SHAPE_LINE_CHAIN& aLine, const PCB_VIA* aVia, PCB_LAYER_ID aLayer, bool aForward );

    void optimiseVias(
            const std::vector<LENGTH_DELAY_CALCULATION_ITEM*>&                            aVias,
            std::vector<LENGTH_DELAY_CALCULATION_ITEM*>&                                  aLines,
            std::map<VECTOR2I, std::unordered_set<LENGTH_DELAY_CALCULATION_ITEM*>>&       aLinesPositionMap,
            const std::map<VECTOR2I, std::unordered_set<LENGTH_DELAY_CALCULATION_ITEM*>>& aPadsPositionMap ) const;

    static void mergeLines( std::vector<LENGTH_DELAY_CALCULATION_ITEM*>&                            aLines,
                            std::map<VECTOR2I, std::unordered_set<LENGTH_DELAY_CALCULATION_ITEM*>>& aLinesPositionMap );

    static void mergeShapeLineChains( SHAPE_LINE_CHAIN& aPrimary, const SHAPE_LINE_CHAIN& aSecondary,
                                      MERGE_POINT aMergePoint );

    void inferViaInPad( const PAD* aPad, const LENGTH_DELAY_CALCULATION_ITEM& aItem, LENGTH_DELAY_STATS& aDetails,
                        std::pair<int64_t, int64_t>& aInferredViaLengthDelay, bool aWithDelayDetail ) const;

    static bool findArcPadIntersection( const SHAPE_ARC& aArc, const std::shared_ptr<SHAPE_POLY_SET>& aPadShape,
                                        const VECTOR2I& aInsidePoint, VECTOR2I& aIntersection );
};
 
#endif //PCBNEW_LENGTH_DELAY_CALCULATION_H