/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2011-2016 Wayne Stambaugh * Copyright (C) 1992-2016 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, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ /** * @file erc.cpp * @brief Electrical Rules Check implementation. */ #include "connection_graph.h" #include #include #include #include #include #include #include #include #include #include #include #include #include /* ERC tests : * 1 - conflicts between connected pins ( example: 2 connected outputs ) * 2 - minimal connections requirements ( 1 input *must* be connected to an * output, or a passive pin ) */ /* * Minimal ERC requirements: * All pins *must* be connected (except ELECTRICAL_PINTYPE::PT_NC). * When a pin is not connected in schematic, the user must place a "non * connected" symbol to this pin. * This ensures a forgotten connection will be detected. */ /* Messages for conflicts : * ELECTRICAL_PINTYPE::PT_INPUT, ELECTRICAL_PINTYPE::PT_OUTPUT, ELECTRICAL_PINTYPE:PT_:BIDI, ELECTRICAL_PINTYPE::PT_TRISTATE, ELECTRICAL_PINTYPE::PT_PASSIVE, * ELECTRICAL_PINTYPE::PT_UNSPECIFIED, ELECTRICAL_PINTYPE::PT_POWER_IN, ELECTRICAL_PINTYPE::PT_POWER_OUT, ELECTRICAL_PINTYPE::PT_OPENCOLLECTOR, * ELECTRICAL_PINTYPE::PT_OPENEMITTER, ELECTRICAL_PINTYPE::PT_NC * These messages are used to show the ERC matrix in ERC dialog */ // Messages for matrix rows: const wxString CommentERC_H[] = { _( "Input Pin" ), _( "Output Pin" ), _( "Bidirectional Pin" ), _( "Tri-State Pin" ), _( "Passive Pin" ), _( "Unspecified Pin" ), _( "Power Input Pin" ), _( "Power Output Pin" ), _( "Open Collector" ), _( "Open Emitter" ), _( "No Connection" ) }; // Messages for matrix columns const wxString CommentERC_V[] = { _( "Input Pin" ), _( "Output Pin" ), _( "Bidirectional Pin" ), _( "Tri-State Pin" ), _( "Passive Pin" ), _( "Unspecified Pin" ), _( "Power Input Pin" ), _( "Power Output Pin" ), _( "Open Collector" ), _( "Open Emitter" ), _( "No Connection" ) }; int ERC_TESTER::TestDuplicateSheetNames( bool aCreateMarker ) { SCH_SCREEN* screen; int err_count = 0; SCH_SCREENS screenList( m_schematic->Root() ); for( screen = screenList.GetFirst(); screen != nullptr; screen = screenList.GetNext() ) { std::vector list; for( SCH_ITEM* item : screen->Items().OfType( SCH_SHEET_T ) ) list.push_back( static_cast( item ) ); for( size_t i = 0; i < list.size(); i++ ) { SCH_SHEET* sheet = list[i]; for( size_t j = i + 1; j < list.size(); j++ ) { SCH_SHEET* test_item = list[j]; // We have found a second sheet: compare names // we are using case insensitive comparison to avoid mistakes between // similar names like Mysheet and mysheet if( sheet->GetName().CmpNoCase( test_item->GetName() ) == 0 ) { if( aCreateMarker ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_DUPLICATE_SHEET_NAME ); ercItem->SetItems( sheet, test_item ); SCH_MARKER* marker = new SCH_MARKER( ercItem, sheet->GetPosition() ); screen->Append( marker ); } err_count++; } } } } return err_count; } void ERC_TESTER::TestTextVars( KIGFX::WS_PROXY_VIEW_ITEM* aWorksheet ) { WS_DRAW_ITEM_LIST wsItems; auto unresolved = [this]( wxString str ) { str = ExpandEnvVarSubstitutions( str, &m_schematic->Prj() ); return str.Matches( wxT( "*${*}*" ) ); }; if( aWorksheet ) { wsItems.SetMilsToIUfactor( IU_PER_MILS ); wsItems.BuildWorkSheetGraphicList( aWorksheet->GetPageInfo(), aWorksheet->GetTitleBlock() ); } SCH_SHEET_PATH savedCurrentSheet = m_schematic->CurrentSheet(); SCH_SHEET_LIST sheets = m_schematic->GetSheets(); for( SCH_SHEET_PATH& sheet : sheets ) { m_schematic->SetCurrentSheet( sheet ); SCH_SCREEN* screen = sheet.LastScreen(); for( SCH_ITEM* item : screen->Items().OfType( SCH_LOCATE_ANY_T ) ) { if( item->Type() == SCH_COMPONENT_T ) { SCH_COMPONENT* component = static_cast( item ); for( SCH_FIELD& field : component->GetFields() ) { if( unresolved( field.GetShownText() ) ) { wxPoint pos = field.GetPosition() - component->GetPosition(); pos = component->GetTransform().TransformCoordinate( pos ); pos += component->GetPosition(); std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE ); ercItem->SetItems( &field ); SCH_MARKER* marker = new SCH_MARKER( ercItem, pos ); screen->Append( marker ); } } } else if( item->Type() == SCH_SHEET_T ) { SCH_SHEET* subSheet = static_cast( item ); for( SCH_FIELD& field : subSheet->GetFields() ) { if( unresolved( field.GetShownText() ) ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE ); ercItem->SetItems( &field ); SCH_MARKER* marker = new SCH_MARKER( ercItem, field.GetPosition() ); screen->Append( marker ); } } for( SCH_SHEET_PIN* pin : static_cast( item )->GetPins() ) { if( pin->GetShownText().Matches( wxT( "*${*}*" ) ) ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE ); ercItem->SetItems( pin ); SCH_MARKER* marker = new SCH_MARKER( ercItem, pin->GetPosition() ); screen->Append( marker ); } } } else if( SCH_TEXT* text = dynamic_cast( item ) ) { if( text->GetShownText().Matches( wxT( "*${*}*" ) ) ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE ); ercItem->SetItems( text ); SCH_MARKER* marker = new SCH_MARKER( ercItem, text->GetPosition() ); screen->Append( marker ); } } } for( WS_DRAW_ITEM_BASE* item = wsItems.GetFirst(); item; item = wsItems.GetNext() ) { if( WS_DRAW_ITEM_TEXT* text = dynamic_cast( item ) ) { if( text->GetShownText().Matches( wxT( "*${*}*" ) ) ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_UNRESOLVED_VARIABLE ); ercItem->SetErrorMessage( _( "Unresolved text variable in worksheet." ) ); SCH_MARKER* marker = new SCH_MARKER( ercItem, text->GetPosition() ); screen->Append( marker ); } } } } m_schematic->SetCurrentSheet( savedCurrentSheet ); } int ERC_TESTER::TestConflictingBusAliases() { wxString msg; int err_count = 0; SCH_SCREENS screens( m_schematic->Root() ); std::vector< std::shared_ptr > aliases; for( SCH_SCREEN* screen = screens.GetFirst(); screen != NULL; screen = screens.GetNext() ) { std::unordered_set< std::shared_ptr > screen_aliases = screen->GetBusAliases(); for( const std::shared_ptr& alias : screen_aliases ) { for( const std::shared_ptr& test : aliases ) { if( alias->GetName() == test->GetName() && alias->Members() != test->Members() ) { msg.Printf( _( "Bus alias %s has conflicting definitions on %s and %s" ), alias->GetName(), alias->GetParent()->GetFileName(), test->GetParent()->GetFileName() ); std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_BUS_ALIAS_CONFLICT ); ercItem->SetErrorMessage( msg ); SCH_MARKER* marker = new SCH_MARKER( ercItem, wxPoint() ); test->GetParent()->Append( marker ); ++err_count; } } } aliases.insert( aliases.end(), screen_aliases.begin(), screen_aliases.end() ); } return err_count; } int ERC_TESTER::TestMultiunitFootprints() { SCH_SHEET_LIST sheets = m_schematic->GetSheets(); int errors = 0; std::map footprints; SCH_MULTI_UNIT_REFERENCE_MAP refMap; sheets.GetMultiUnitComponents( refMap, true ); for( auto& component : refMap ) { auto& refList = component.second; if( refList.GetCount() == 0 ) { wxFAIL; // it should not happen continue; } // Reference footprint SCH_COMPONENT* unit = nullptr; wxString unitName; wxString unitFP; for( unsigned i = 0; i < component.second.GetCount(); ++i ) { SCH_SHEET_PATH sheetPath = refList.GetItem( i ).GetSheetPath(); unitFP = refList.GetItem( i ).GetComp()->GetField( FOOTPRINT )->GetText(); if( !unitFP.IsEmpty() ) { unit = refList.GetItem( i ).GetComp(); unitName = unit->GetRef( &sheetPath, true ); break; } } for( unsigned i = 0; i < component.second.GetCount(); ++i ) { SCH_REFERENCE& secondRef = refList.GetItem( i ); SCH_COMPONENT* secondUnit = secondRef.GetComp(); wxString secondName = secondUnit->GetRef( &secondRef.GetSheetPath(), true ); const wxString secondFp = secondUnit->GetField( FOOTPRINT )->GetText(); wxString msg; if( !secondFp.IsEmpty() && unitFP != secondFp ) { msg.Printf( _( "Different footprints assigned to %s and %s" ), unitName, secondName ); std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_DIFFERENT_UNIT_FP ); ercItem->SetErrorMessage( msg ); ercItem->SetItems( unit, secondUnit ); SCH_MARKER* marker = new SCH_MARKER( ercItem, secondUnit->GetPosition() ); secondRef.GetSheetPath().LastScreen()->Append( marker ); ++errors; } } } return errors; } void ERC_TESTER::diagnose( NETLIST_OBJECT* aNetItemRef, NETLIST_OBJECT* aNetItemTst, int aMinConn, PIN_ERROR aDiag ) { if( aDiag == PIN_ERROR::OK || aMinConn < 1 || aNetItemRef->m_Type != NETLIST_ITEM::PIN ) return; ERC_SETTINGS& settings = m_schematic->ErcSettings(); SCH_PIN* pin = static_cast( aNetItemRef->m_Comp ); if( aNetItemTst == NULL) { if( aMinConn == NOD ) /* Nothing driving the net. */ { if( settings.GetSeverity( ERCE_PIN_NOT_DRIVEN ) != RPT_SEVERITY_IGNORE ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_PIN_NOT_DRIVEN ); ercItem->SetItems( pin ); SCH_MARKER* marker = new SCH_MARKER( ercItem, aNetItemRef->m_Start ); aNetItemRef->m_SheetPath.LastScreen()->Append( marker ); } return; } } if( aNetItemTst && aNetItemTst->m_Type == NETLIST_ITEM::PIN ) /* Error between 2 pins */ { if( settings.GetSeverity( ERCE_PIN_TO_PIN_WARNING ) != RPT_SEVERITY_IGNORE ) { std::shared_ptr ercItem = ERC_ITEM::Create( aDiag == PIN_ERROR::PP_ERROR ? ERCE_PIN_TO_PIN_ERROR : ERCE_PIN_TO_PIN_WARNING ); ercItem->SetItems( pin, static_cast( aNetItemTst->m_Comp ) ); SCH_MARKER* marker = new SCH_MARKER( ercItem, aNetItemRef->m_Start ); aNetItemRef->m_SheetPath.LastScreen()->Append( marker ); } } } void ERC_TESTER::TestOthersItems( NETLIST_OBJECT_LIST* aList, unsigned aNetItemRef, unsigned aNetStart, int* aMinConnexion ) { ERC_SETTINGS& settings = m_schematic->ErcSettings(); unsigned netItemTst = aNetStart; ELECTRICAL_PINTYPE jj; PIN_ERROR erc = PIN_ERROR::OK; /* Analysis of the table of connections. */ ELECTRICAL_PINTYPE ref_elect_type = aList->GetItem( aNetItemRef )->m_ElectricalPinType; int local_minconn = NOC; if( ref_elect_type == ELECTRICAL_PINTYPE::PT_NC ) local_minconn = NPI; /* Test pins connected to NetItemRef */ for( ; ; netItemTst++ ) { if( aNetItemRef == netItemTst ) continue; // We examine only a given net. We stop the search if the net changes if( ( netItemTst >= aList->size() ) // End of list || ( aList->GetItemNet( aNetItemRef ) != aList->GetItemNet( netItemTst ) ) ) // End of net { /* End net code found: minimum connection test. */ if( ( *aMinConnexion < NET_NC ) && ( local_minconn < NET_NC ) ) { /* Not connected or not driven pin. */ bool seterr = true; if( local_minconn == NOC && aList->GetItemType( aNetItemRef ) == NETLIST_ITEM::PIN ) { /* This pin is not connected: for multiple part per * package, and duplicated pin, * search for another instance of this pin * this will be flagged only if all instances of this pin * are not connected * TODO test also if instances connected are connected to * the same net */ for( unsigned duplicate = 0; duplicate < aList->size(); duplicate++ ) { if( aList->GetItemType( duplicate ) != NETLIST_ITEM::PIN ) continue; if( duplicate == aNetItemRef ) continue; if( aList->GetItem( aNetItemRef )->m_PinNum != aList->GetItem( duplicate )->m_PinNum ) continue; if( ( (SCH_COMPONENT*) aList->GetItem( aNetItemRef )-> m_Link )->GetRef( &aList->GetItem( aNetItemRef )-> m_SheetPath ) != ( (SCH_COMPONENT*) aList->GetItem( duplicate )->m_Link ) ->GetRef( &aList->GetItem( duplicate )->m_SheetPath ) ) continue; // Same component and same pin. Do dot create error for this pin // if the other pin is connected (i.e. if duplicate net has another // item) if( (duplicate > 0) && ( aList->GetItemNet( duplicate ) == aList->GetItemNet( duplicate - 1 ) ) ) seterr = false; if( (duplicate < aList->size() - 1) && ( aList->GetItemNet( duplicate ) == aList->GetItemNet( duplicate + 1 ) ) ) seterr = false; } } if( seterr ) { diagnose( aList->GetItem( aNetItemRef ), nullptr, local_minconn, PIN_ERROR::WARNING ); } *aMinConnexion = DRV; // inhibiting other messages of this // type for the net. } return; } switch( aList->GetItemType( netItemTst ) ) { case NETLIST_ITEM::ITEM_UNSPECIFIED: case NETLIST_ITEM::SEGMENT: case NETLIST_ITEM::BUS: case NETLIST_ITEM::JUNCTION: case NETLIST_ITEM::LABEL: case NETLIST_ITEM::HIERLABEL: case NETLIST_ITEM::BUSLABELMEMBER: case NETLIST_ITEM::HIERBUSLABELMEMBER: case NETLIST_ITEM::SHEETBUSLABELMEMBER: case NETLIST_ITEM::SHEETLABEL: case NETLIST_ITEM::GLOBLABEL: case NETLIST_ITEM::GLOBBUSLABELMEMBER: case NETLIST_ITEM::PINLABEL: break; case NETLIST_ITEM::NOCONNECT: local_minconn = std::max( NET_NC, local_minconn ); break; case NETLIST_ITEM::PIN: jj = aList->GetItem( netItemTst )->m_ElectricalPinType; local_minconn = std::max( settings.GetPinMinDrive( ref_elect_type, jj ), local_minconn ); if( netItemTst <= aNetItemRef ) break; if( erc == PIN_ERROR::OK ) { erc = settings.GetPinMapValue( ref_elect_type, jj ); if( erc != PIN_ERROR::OK ) { if( aList->GetConnectionType( netItemTst ) == NET_CONNECTION::UNCONNECTED ) { aList->SetConnectionType( netItemTst, NET_CONNECTION::NOCONNECT_SYMBOL_PRESENT ); } diagnose( aList->GetItem( aNetItemRef ), aList->GetItem( netItemTst ), 1, erc ); } } break; } } } int ERC_TESTER::TestNoConnectPins() { int err_count = 0; for( const SCH_SHEET_PATH& sheet : m_schematic->GetSheets() ) { std::map> pinMap; for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_COMPONENT_T ) ) { SCH_COMPONENT* comp = static_cast( item ); for( SCH_PIN* pin : comp->GetPins( &sheet ) ) { if( pin->GetLibPin()->GetType() == ELECTRICAL_PINTYPE::PT_NC ) pinMap[pin->GetPosition()].emplace_back( pin ); } } for( auto& pair : pinMap ) { if( pair.second.size() > 1 ) { err_count++; std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_NOCONNECT_CONNECTED ); ercItem->SetItems( pair.second[0], pair.second[1], pair.second.size() > 2 ? pair.second[2] : nullptr, pair.second.size() > 3 ? pair.second[3] : nullptr ); ercItem->SetErrorMessage( _( "Pins with \"no connection\" type are connected" ) ); SCH_MARKER* marker = new SCH_MARKER( ercItem, pair.first ); sheet.LastScreen()->Append( marker ); } } } return err_count; } int ERC_TESTER::TestPinToPin() { ERC_SETTINGS& settings = m_schematic->ErcSettings(); const NET_MAP& nets = m_schematic->ConnectionGraph()->GetNetMap(); int errors = 0; for( const std::pair> net : nets ) { std::vector pins; std::unordered_map pinToScreenMap; for( CONNECTION_SUBGRAPH* subgraph: net.second ) { for( EDA_ITEM* item : subgraph->m_items ) { if( item->Type() == SCH_PIN_T ) { pins.emplace_back( static_cast( item ) ); pinToScreenMap[item] = subgraph->m_sheet.LastScreen(); } } } // Single-pin nets are handled elsewhere if( pins.size() < 2 ) continue; std::set> tested; for( SCH_PIN* refPin : pins ) { ELECTRICAL_PINTYPE refType = refPin->GetType(); for( SCH_PIN* testPin : pins ) { if( testPin == refPin ) continue; std::pair pair1 = std::make_pair( refPin, testPin ); std::pair pair2 = std::make_pair( testPin, refPin ); if( tested.count( pair1 ) || tested.count( pair2 ) ) continue; tested.insert( pair1 ); tested.insert( pair2 ); ELECTRICAL_PINTYPE testType = testPin->GetType(); PIN_ERROR erc = settings.GetPinMapValue( refType, testType ); if( erc != PIN_ERROR::OK ) { std::shared_ptr ercItem = ERC_ITEM::Create( erc == PIN_ERROR::WARNING ? ERCE_PIN_TO_PIN_WARNING : ERCE_PIN_TO_PIN_ERROR ); ercItem->SetItems( refPin, testPin ); ercItem->SetErrorMessage( wxString::Format( _( "Pins of type %s and %s are connected" ), ElectricalPinTypeGetText( refType ), ElectricalPinTypeGetText( testType ) ) ); SCH_MARKER* marker = new SCH_MARKER( ercItem, refPin->GetTransformedPosition() ); pinToScreenMap[refPin]->Append( marker ); errors++; } } } } return errors; } int ERC_TESTER::TestMultUnitPinConflicts() { const NET_MAP& nets = m_schematic->ConnectionGraph()->GetNetMap(); int errors = 0; std::unordered_map> pinToNetMap; for( const std::pair> net : nets ) { const wxString& netName = net.first.first; std::vector pins; for( CONNECTION_SUBGRAPH* subgraph : net.second ) { for( EDA_ITEM* item : subgraph->m_items ) { if( item->Type() == SCH_PIN_T ) { SCH_PIN* pin = static_cast( item ); if( !pin->GetLibPin()->GetParent()->IsMulti() ) continue; wxString name = ( pin->GetParentComponent()->GetRef( &subgraph->m_sheet ) + ":" + pin->GetName() ); if( !pinToNetMap.count( name ) ) { pinToNetMap[name] = std::make_pair( netName, pin ); } else if( pinToNetMap[name].first != netName ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_DIFFERENT_UNIT_NET ); ercItem->SetErrorMessage( wxString::Format( _( "Pin %s is connected to both %s and %s" ), pin->GetNumber(), netName, pinToNetMap[name].first ) ); ercItem->SetItems( pin, pinToNetMap[name].second ); SCH_MARKER* marker = new SCH_MARKER( ercItem, pin->GetTransformedPosition() ); subgraph->m_sheet.LastScreen()->Append( marker ); } } } } } return errors; } int ERC_TESTER::TestSimilarLabels() { const NET_MAP& nets = m_schematic->ConnectionGraph()->GetNetMap(); int errors = 0; std::unordered_map labelMap; for( const std::pair> net : nets ) { const wxString& netName = net.first.first; std::vector pins; for( CONNECTION_SUBGRAPH* subgraph : net.second ) { for( EDA_ITEM* item : subgraph->m_items ) { switch( item->Type() ) { case SCH_LABEL_T: case SCH_HIER_LABEL_T: case SCH_GLOBAL_LABEL_T: { SCH_TEXT* text = static_cast( item ); wxString normalized = text->GetShownText().Lower(); if( !labelMap.count( normalized ) ) { labelMap[normalized] = text; } else if( labelMap.at( normalized )->GetShownText() != text->GetShownText() ) { std::shared_ptr ercItem = ERC_ITEM::Create( ERCE_SIMILAR_LABELS ); ercItem->SetItems( text, labelMap.at( normalized ) ); SCH_MARKER* marker = new SCH_MARKER( ercItem, text->GetPosition() ); subgraph->m_sheet.LastScreen()->Append( marker ); } break; } default: break; } } } } return errors; }