KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_test_provider_solder_mask.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <common.h>
27#include <footprint.h>
28#include <pad.h>
29#include <pcb_track.h>
30#include <pcb_text.h>
31#include <thread_pool.h>
32#include <zone.h>
33#include <geometry/seg.h>
34#include <drc/drc_engine.h>
35#include <drc/drc_item.h>
36#include <drc/drc_rule.h>
38#include <drc/drc_rtree.h>
39
40/*
41 Solder mask tests. Checks for silkscreen which is clipped by mask openings and for bridges
42 between mask apertures with different nets.
43 Errors generated:
44 - DRCE_SILK_MASK_CLEARANCE
45 - DRCE_SOLDERMASK_BRIDGE
46*/
47
49{
50public:
52 m_board( nullptr ),
53 m_webWidth( 0 ),
54 m_maxError( 0 ),
56 {
57 m_bridgeRule.m_Name = _( "board setup solder mask min width" );
58 }
59
60 virtual ~DRC_TEST_PROVIDER_SOLDER_MASK() = default;
61
62 virtual bool Run() override;
63
64 virtual const wxString GetName() const override { return wxT( "solder_mask_issues" ); };
65
66private:
67 void addItemToRTrees( BOARD_ITEM* aItem );
68 void buildRTrees();
69
71 void testMaskBridges();
72
73 void testItemAgainstItems( BOARD_ITEM* aItem, const BOX2I& aItemBBox,
74 PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer );
75 void testMaskItemAgainstZones( BOARD_ITEM* item, const BOX2I& itemBBox,
76 PCB_LAYER_ID refLayer, PCB_LAYER_ID targetLayer );
77
78 bool checkMaskAperture( BOARD_ITEM* aMaskItem, BOARD_ITEM* aTestItem, PCB_LAYER_ID aTestLayer,
79 int aTestNet, BOARD_ITEM** aCollidingItem );
80
81 bool checkItemMask( BOARD_ITEM* aItem, int aTestNet );
82
83private:
85
90
91 std::unique_ptr<DRC_RTREE> m_fullSolderMaskRTree;
92 std::unique_ptr<DRC_RTREE> m_itemTree;
93
95 std::unordered_map<PTR_PTR_CACHE_KEY, LSET> m_checkedPairs;
96
97 // Shapes used to define solder mask apertures don't have nets, so we assign them the
98 // first object+net that bridges their aperture (after which any other nets will generate
99 // violations).
100 std::mutex m_netMapMutex;
101 std::unordered_map<PTR_LAYER_CACHE_KEY, std::pair<BOARD_ITEM*, int>> m_maskApertureNetMap;
102};
103
104
106{
107 for( PCB_LAYER_ID layer : { F_Mask, B_Mask } )
108 {
109 if( !aItem->IsOnLayer( layer ) )
110 continue;
111
112 SHAPE_POLY_SET* solderMask = m_board->m_SolderMaskBridges->GetFill( layer );
113
114 if( aItem->Type() == PCB_ZONE_T )
115 {
116 ZONE* zone = static_cast<ZONE*>( aItem );
117
118 solderMask->BooleanAdd( *zone->GetFilledPolysList( layer ) );
119 }
120 else
121 {
122 int clearance = m_webWidth / 2;
123
124 if( aItem->Type() == PCB_PAD_T )
125 clearance += static_cast<PAD*>( aItem )->GetSolderMaskExpansion( layer );
126 else if( aItem->Type() == PCB_VIA_T )
127 clearance += static_cast<PCB_VIA*>( aItem )->GetSolderMaskExpansion();
128 else if( aItem->Type() == PCB_SHAPE_T )
129 clearance += static_cast<PCB_SHAPE*>( aItem )->GetSolderMaskExpansion();
130
131 if( aItem->Type() == PCB_FIELD_T || aItem->Type() == PCB_TEXT_T )
132 {
133 PCB_TEXT* text = static_cast<PCB_TEXT*>( aItem );
134
135 text->TransformTextToPolySet( *solderMask, clearance, m_maxError, ERROR_OUTSIDE );
136 }
137 else
138 {
139 aItem->TransformShapeToPolygon( *solderMask, layer, clearance, m_maxError, ERROR_OUTSIDE );
140 }
141
142 m_itemTree->Insert( aItem, layer, m_largestClearance );
143 }
144 }
145}
146
147
149{
150 ZONE* solderMask = m_board->m_SolderMaskBridges;
151 LSET layers( { F_Mask, B_Mask, F_Cu, B_Cu } );
152
153 const size_t progressDelta = 500;
154 int count = 0;
155 int ii = 0;
156
157 solderMask->GetFill( F_Mask )->RemoveAllContours();
158 solderMask->GetFill( B_Mask )->RemoveAllContours();
159
160 m_fullSolderMaskRTree = std::make_unique<DRC_RTREE>();
161 m_itemTree = std::make_unique<DRC_RTREE>();
162
164 [&]( BOARD_ITEM* item ) -> bool
165 {
166 ++count;
167 return true;
168 } );
169
171 [&]( BOARD_ITEM* item ) -> bool
172 {
173 if( !reportProgress( ii++, count, progressDelta ) )
174 return false;
175
176 addItemToRTrees( item );
177 return true;
178 } );
179
180 solderMask->GetFill( F_Mask )->Simplify();
181 solderMask->GetFill( B_Mask )->Simplify();
182
183 if( m_webWidth > 0 )
184 {
187 }
188
189 solderMask->SetFillFlag( F_Mask, true );
190 solderMask->SetFillFlag( B_Mask, true );
191 solderMask->SetIsFilled( true );
192
193 solderMask->CacheTriangulation();
194
195 m_fullSolderMaskRTree->Insert( solderMask, F_Mask );
196 m_fullSolderMaskRTree->Insert( solderMask, B_Mask );
197
198 m_checkedPairs.clear();
199}
200
201
203{
204 LSET silkLayers( { F_SilkS, B_SilkS } );
205
206 // If we have no minimum web width then we delegate to the silk checker which does object-to-object
207 // testing (instead of object-to-solder-mask-zone-fill checking that we do here).
208 if( m_webWidth <= 0 )
209 return;
210
211 const size_t progressDelta = 250;
212 int count = 0;
213 int ii = 0;
214
216 [&]( BOARD_ITEM* item ) -> bool
217 {
218 ++count;
219 return true;
220 } );
221
223 [&]( BOARD_ITEM* item ) -> bool
224 {
225 if( m_drcEngine->IsErrorLimitExceeded( DRCE_SILK_MASK_CLEARANCE ) )
226 return false;
227
228 if( !reportProgress( ii++, count, progressDelta ) )
229 return false;
230
231 if( isInvisibleText( item ) )
232 return true;
233
234 for( PCB_LAYER_ID layer : silkLayers )
235 {
236 if( !item->IsOnLayer( layer ) )
237 continue;
238
239 PCB_LAYER_ID maskLayer = layer == F_SilkS ? F_Mask : B_Mask;
240 BOX2I itemBBox = item->GetBoundingBox();
242 item, nullptr, maskLayer );
243 int clearance = constraint.GetValue().Min();
244 int actual;
245 VECTOR2I pos;
246
247 if( constraint.GetSeverity() == RPT_SEVERITY_IGNORE || clearance < 0 )
248 return true;
249
250 std::shared_ptr<SHAPE> itemShape = item->GetEffectiveShape( layer );
251
252 if( m_fullSolderMaskRTree->QueryColliding( itemBBox, itemShape.get(), maskLayer,
253 clearance, &actual, &pos ) )
254 {
255 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_SILK_MASK_CLEARANCE );
256
257 if( clearance > 0 )
258 {
259 drce->SetErrorDetail( formatMsg( _( "(%s clearance %s; actual %s)" ),
260 constraint.GetName(),
261 clearance,
262 actual ) );
263 }
264
265 drce->SetItems( item );
266 drce->SetViolatingRule( constraint.GetParentRule() );
267
268 reportViolation( drce, pos, layer );
269 }
270 }
271
272 return true;
273 } );
274}
275
276
278{
279 if( aItem->Type() == PCB_PAD_T )
280 {
281 PAD* pad = static_cast<PAD*>( aItem );
282
283 // TODO(JE) padstacks
284 if( pad->GetAttribute() == PAD_ATTRIB::NPTH
285 && ( pad->GetShape( PADSTACK::ALL_LAYERS ) == PAD_SHAPE::CIRCLE
286 || pad->GetShape( PADSTACK::ALL_LAYERS ) == PAD_SHAPE::OVAL )
287 && pad->GetSize( PADSTACK::ALL_LAYERS ).x <= pad->GetDrillSize().x
288 && pad->GetSize( PADSTACK::ALL_LAYERS ).y <= pad->GetDrillSize().y )
289 {
290 return true;
291 }
292 }
293
294 return false;
295}
296
297
298// Simple mask apertures aren't associated with copper items, so they only constitute a bridge
299// when they expose other copper items having at least two distinct nets. We use a map to record
300// the first net exposed by each mask aperture (on each copper layer).
301//
302// Note that this algorithm is also used for free pads.
303
305{
306 if( aItem->Type() == PCB_PAD_T && static_cast<PAD*>( aItem )->IsFreePad() )
307 return true;
308
309 static const LSET saved( { F_Mask, B_Mask } );
310
311 LSET maskLayers = aItem->GetLayerSet() & saved;
312 LSET copperLayers = ( aItem->GetLayerSet() & ~saved ) & LSET::AllCuMask();
313
314 return maskLayers.count() > 0 && copperLayers.count() == 0;
315}
316
317
319 PCB_LAYER_ID aTestLayer, int aTestNet,
320 BOARD_ITEM** aCollidingItem )
321{
322 if( aTestLayer == F_Mask && !aTestItem->IsOnLayer( F_Cu ) )
323 return false;
324
325 if( aTestLayer == B_Mask && !aTestItem->IsOnLayer( B_Cu ) )
326 return false;
327
328 PCB_LAYER_ID maskLayer = IsFrontLayer( aTestLayer ) ? F_Mask : B_Mask;
329
330 FOOTPRINT* fp = aMaskItem->GetParentFootprint();
331
332 // Mask apertures in footprints which allow soldermask bridges are ignored entirely.
333 if( fp && fp->AllowSolderMaskBridges() )
334 return false;
335
336 PTR_LAYER_CACHE_KEY key = { aMaskItem, maskLayer };
337 BOARD_ITEM* alreadyEncounteredItem = nullptr;
338 int encounteredItemNet = -1;
339
340 {
341 std::lock_guard<std::mutex> lock( m_checkedPairsMutex );
342 auto ii = m_maskApertureNetMap.find( key );
343
344 if( ii == m_maskApertureNetMap.end() )
345 {
346 m_maskApertureNetMap[ key ] = { aTestItem, aTestNet };
347
348 // First net; no bridge yet....
349 return false;
350 }
351
352 alreadyEncounteredItem = ii->second.first;
353 encounteredItemNet = ii->second.second;
354 }
355
356 if( encounteredItemNet == aTestNet && aTestNet >= 0 )
357 {
358 // Same net; still no bridge...
359 return false;
360 }
361
362 if( fp && aTestItem->GetParentFootprint() == fp )
363 {
364 std::map<wxString, int> padToNetTieGroupMap = fp->MapPadNumbersToNetTieGroups();
365 PAD* padA = nullptr;
366 PAD* padB = nullptr;
367
368 if( alreadyEncounteredItem->Type() == PCB_PAD_T )
369 padA = static_cast<PAD*>( alreadyEncounteredItem );
370
371 if( aTestItem->Type() == PCB_PAD_T )
372 padB = static_cast<PAD*>( aTestItem );
373
374 if( padA && padB && ( padA->SameLogicalPadAs( padB ) || padA->SharesNetTieGroup( padB ) ) )
375 {
376 return false;
377 }
378 else if( padA && aTestItem->Type() == PCB_SHAPE_T )
379 {
380 if( padToNetTieGroupMap.contains( padA->GetNumber() ) )
381 return false;
382 }
383 else if( padB && alreadyEncounteredItem->Type() == PCB_SHAPE_T )
384 {
385 if( padToNetTieGroupMap.contains( padB->GetNumber() ) )
386 return false;
387 }
388 }
389
390 *aCollidingItem = alreadyEncounteredItem;
391 return true;
392}
393
394
396{
397 if( FOOTPRINT* fp = aItem->GetParentFootprint() )
398 {
399 // If we're allowing bridges then we're allowing bridges. Nothing to check.
400 if( fp->AllowSolderMaskBridges() )
401 return false;
402
403 // Items belonging to a net-tie may share the mask aperture of pads in the same group.
404 if( aItem->Type() == PCB_PAD_T && fp->IsNetTie() )
405 {
406 PAD* pad = static_cast<PAD*>( aItem );
407 std::map<wxString, int> padNumberToGroupIdxMap = fp->MapPadNumbersToNetTieGroups();
408 int groupIdx = padNumberToGroupIdxMap[ pad->GetNumber() ];
409
410 if( groupIdx >= 0 )
411 {
412 if( aTestNet < 0 )
413 return false;
414
415 if( pad->GetNetCode() == aTestNet )
416 return false;
417
418 for( PAD* other : fp->GetNetTiePads( pad ) )
419 {
420 if( other->GetNetCode() == aTestNet )
421 return false;
422 }
423 }
424 }
425 }
426
427 return true;
428}
429
430
432 PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer )
433{
434 PAD* pad = aItem->Type() == PCB_PAD_T ? static_cast<PAD*>( aItem ) : nullptr;
435 PCB_VIA* via = aItem->Type() == PCB_VIA_T ? static_cast<PCB_VIA*>( aItem ) : nullptr;
436 PCB_SHAPE* shape = aItem->Type() == PCB_SHAPE_T ? static_cast<PCB_SHAPE*>( aItem ) : nullptr;
437 int itemNet = -1;
438
439 std::optional<DRC_CONSTRAINT> itemConstraint;
440 DRC_CONSTRAINT otherConstraint;
441
442 if( aItem->IsConnected() )
443 itemNet = static_cast<BOARD_CONNECTED_ITEM*>( aItem )->GetNetCode();
444
445 std::shared_ptr<SHAPE> itemShape = aItem->GetEffectiveShape( aRefLayer );
446
447 m_itemTree->QueryColliding( aItem, aRefLayer, aTargetLayer,
448 // Filter:
449 [&]( BOARD_ITEM* other ) -> bool
450 {
451 FOOTPRINT* itemFP = aItem->GetParentFootprint();
452 PAD* otherPad = other->Type() == PCB_PAD_T ? static_cast<PAD*>( other ) : nullptr;
453 int otherNet = -1;
454
455 if( other->IsConnected() )
456 otherNet = static_cast<BOARD_CONNECTED_ITEM*>( other )->GetNetCode();
457
458 if( otherNet > 0 && otherNet == itemNet )
459 return false;
460
461 if( isNullAperture( other ) )
462 return false;
463
464 if( itemFP && itemFP == other->GetParentFootprint() )
465 {
466 // Board-wide exclusion
467 if( BOARD* board = itemFP->GetBoard() )
468 {
469 if( board->GetDesignSettings().m_AllowSoldermaskBridgesInFPs )
470 return false;
471 }
472
473 // Footprint-specific exclusion
474 if( itemFP->AllowSolderMaskBridges() )
475 return false;
476 }
477
478 if( pad && otherPad && ( pad->SameLogicalPadAs( otherPad )
479 || pad->SharesNetTieGroup( otherPad ) ) )
480 {
481 return false;
482 }
483
484 if( itemFP && itemFP->IsNetTie() )
485 {
486 const std::set<int>& nets = itemFP->GetNetTieCache( aItem );
487
488 if( otherNet < 0 || nets.count( otherNet ) )
489 return false;
490 }
491
492 if( FOOTPRINT* otherFP = other->GetParentFootprint(); otherFP && otherFP->IsNetTie() )
493 {
494 const std::set<int>& nets = otherFP->GetNetTieCache( other );
495
496 if( itemNet < 0 || nets.count( itemNet ) )
497 return false;
498 }
499
500 BOARD_ITEM* a = aItem;
501 BOARD_ITEM* b = other;
502
503 // store canonical order so we don't collide in both directions (a:b and b:a)
504 if( static_cast<void*>( a ) > static_cast<void*>( b ) )
505 std::swap( a, b );
506
507 {
508 std::lock_guard<std::mutex> lock( m_checkedPairsMutex );
509 auto it = m_checkedPairs.find( { a, b } );
510
511 if( it != m_checkedPairs.end() && it->second.test( aTargetLayer ) )
512 {
513 return false;
514 }
515 else
516 {
517 m_checkedPairs[{ a, b }].set( aTargetLayer );
518 return true;
519 }
520 }
521 },
522 // Visitor:
523 [&]( BOARD_ITEM* other ) -> bool
524 {
525 PAD* otherPad = other->Type() == PCB_PAD_T ? static_cast<PAD*>( other ) : nullptr;
526 PCB_VIA* otherVia = other->Type() == PCB_VIA_T ? static_cast<PCB_VIA*>( other ) : nullptr;
527 PCB_SHAPE* otherShape = other->Type() == PCB_SHAPE_T ? static_cast<PCB_SHAPE*>( other ) : nullptr;
528 auto otherItemShape = other->GetEffectiveShape( aTargetLayer );
529 int otherNet = -1;
530
531 if( other->IsConnected() )
532 otherNet = static_cast<BOARD_CONNECTED_ITEM*>( other )->GetNetCode();
533
534 int actual;
535 VECTOR2I pos;
536 int clearance = 0;
537
538 if( aRefLayer == F_Mask || aRefLayer == B_Mask )
539 {
540 // Aperture-to-aperture must enforce web-min-width
542 }
543 else // ( aRefLayer == F_Cu || aRefLayer == B_Cu )
544 {
545 // Copper-to-aperture uses the solder-mask-to-copper-clearance
546 clearance = m_board->GetDesignSettings().m_SolderMaskToCopperClearance;
547 }
548
549 if( pad )
550 clearance += pad->GetSolderMaskExpansion( aRefLayer );
551 else if( via && !via->IsTented( aRefLayer ) )
552 clearance += via->GetSolderMaskExpansion();
553 else if( shape )
555
556 if( otherPad )
557 clearance += otherPad->GetSolderMaskExpansion( aTargetLayer );
558 else if( otherVia && !otherVia->IsTented( aTargetLayer ) )
559 clearance += otherVia->GetSolderMaskExpansion();
560 else if( otherShape )
561 clearance += otherShape->GetSolderMaskExpansion();
562
563 if( itemShape->Collide( otherItemShape.get(), clearance, &actual, &pos ) )
564 {
565 if( !itemConstraint.has_value() )
566 itemConstraint = m_drcEngine->EvalRules( BRIDGED_MASK_CONSTRAINT, aItem, nullptr, aRefLayer );
567
568 otherConstraint = m_drcEngine->EvalRules( BRIDGED_MASK_CONSTRAINT, other, nullptr, aTargetLayer );
569
570 bool itemConstraintIgnored = itemConstraint->GetSeverity() == RPT_SEVERITY_IGNORE;
571 bool otherConstraintIgnored = otherConstraint.GetSeverity() == RPT_SEVERITY_IGNORE;
572
573 // Mask apertures are ignored on their own; in other cases both participants must be ignored
574 if( ( isMaskAperture( aItem ) && itemConstraintIgnored )
575 || ( isMaskAperture( other ) && otherConstraintIgnored )
576 || ( itemConstraintIgnored && otherConstraintIgnored ) )
577 {
578 return !m_drcEngine->IsCancelled();
579 }
580
581 wxString msg;
582 BOARD_ITEM* colliding = nullptr;
583
584 if( aTargetLayer == F_Mask )
585 msg = _( "Front solder mask aperture bridges items with different nets" );
586 else
587 msg = _( "Rear solder mask aperture bridges items with different nets" );
588
589 // Simple mask apertures aren't associated with copper items, so they only
590 // constitute a bridge when they expose other copper items having at least
591 // two distinct nets.
592 if( isMaskAperture( aItem ) )
593 {
594 if( checkMaskAperture( aItem, other, aRefLayer, otherNet, &colliding ) )
595 {
596 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_SOLDERMASK_BRIDGE );
597
598 drce->SetErrorMessage( msg );
599 drce->SetItems( aItem, colliding, other );
600 drce->SetViolatingRule( &m_bridgeRule );
601 reportViolation( drce, pos, aTargetLayer );
602 }
603 }
604 else if( isMaskAperture( other ) )
605 {
606 if( checkMaskAperture( other, aItem, aRefLayer, itemNet, &colliding ) )
607 {
608 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_SOLDERMASK_BRIDGE );
609
610 drce->SetErrorMessage( msg );
611 drce->SetItems( other, colliding, aItem );
612 drce->SetViolatingRule( &m_bridgeRule );
613 reportViolation( drce, pos, aTargetLayer );
614 }
615 }
616 else if( checkItemMask( other, itemNet ) )
617 {
618 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_SOLDERMASK_BRIDGE );
619
620 drce->SetErrorMessage( msg );
621 drce->SetItems( aItem, other );
622 drce->SetViolatingRule( &m_bridgeRule );
623 reportViolation( drce, pos, aTargetLayer );
624 }
625 }
626
627 return !m_drcEngine->IsCancelled();
628 },
630}
631
632
634 PCB_LAYER_ID aMaskLayer, PCB_LAYER_ID aTargetLayer )
635{
636 PAD* pad = aItem->Type() == PCB_PAD_T ? static_cast<PAD*>( aItem ) : nullptr;
637 PCB_VIA* via = aItem->Type() == PCB_VIA_T ? static_cast<PCB_VIA*>( aItem ) : nullptr;
638 PCB_SHAPE* shape = aItem->Type() == PCB_SHAPE_T ? static_cast<PCB_SHAPE*>( aItem ) : nullptr;
639
640 for( ZONE* zone : m_board->m_DRCCopperZones )
641 {
642 if( !zone->GetLayerSet().test( aTargetLayer ) )
643 continue;
644
645 int zoneNet = zone->GetNetCode();
646
647 if( aItem->IsConnected() )
648 {
649 BOARD_CONNECTED_ITEM* connectedItem = static_cast<BOARD_CONNECTED_ITEM*>( aItem );
650
651 if( zoneNet == connectedItem->GetNetCode() && zoneNet > 0 )
652 continue;
653 }
654
655 BOX2I inflatedBBox( aItemBBox );
656 int clearance = m_board->GetDesignSettings().m_SolderMaskToCopperClearance;
657
658 if( pad )
659 clearance += pad->GetSolderMaskExpansion( aTargetLayer );
660 else if( via && !via->IsTented( aTargetLayer ) )
661 clearance += via->GetSolderMaskExpansion();
662 else if( shape )
664
665 inflatedBBox.Inflate( clearance );
666
667 if( !inflatedBBox.Intersects( zone->GetBoundingBox() ) )
668 continue;
669
670 DRC_RTREE* zoneTree = m_board->m_CopperZoneRTreeCache[ zone ].get();
671 int actual;
672 VECTOR2I pos;
673
674 std::shared_ptr<SHAPE> itemShape = aItem->GetEffectiveShape( aMaskLayer );
675
676 if( zoneTree && zoneTree->QueryColliding( aItemBBox, itemShape.get(), aTargetLayer, clearance,
677 &actual, &pos ) )
678 {
679 wxString msg;
680 BOARD_ITEM* colliding = nullptr;
681
682 if( aMaskLayer == F_Mask )
683 msg = _( "Front solder mask aperture bridges items with different nets" );
684 else
685 msg = _( "Rear solder mask aperture bridges items with different nets" );
686
687 // Simple mask apertures aren't associated with copper items, so they only constitute
688 // a bridge when they expose other copper items having at least two distinct nets.
689 if( isMaskAperture( aItem ) && zoneNet >= 0 )
690 {
691 if( checkMaskAperture( aItem, zone, aTargetLayer, zoneNet, &colliding ) )
692 {
693 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_SOLDERMASK_BRIDGE );
694
695 drce->SetErrorMessage( msg );
696 drce->SetItems( aItem, colliding, zone );
697 drce->SetViolatingRule( &m_bridgeRule );
698 reportViolation( drce, pos, aTargetLayer );
699 }
700 }
701 else
702 {
703 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_SOLDERMASK_BRIDGE );
704
705 drce->SetErrorMessage( msg );
706 drce->SetItems( aItem, zone );
707 drce->SetViolatingRule( &m_bridgeRule );
708 reportViolation( drce, pos, aTargetLayer );
709 }
710 }
711
712 if( m_drcEngine->IsCancelled() )
713 return;
714 }
715}
716
717
719{
720 LSET copperAndMaskLayers( { F_Mask, B_Mask, F_Cu, B_Cu } );
721 std::atomic<int> count = 0;
722 std::vector<BOARD_ITEM*> test_items;
723
724 forEachGeometryItem( s_allBasicItemsButZones, copperAndMaskLayers,
725 [&]( BOARD_ITEM* item ) -> bool
726 {
727 test_items.push_back( item );
728 return true;
729 } );
730
732
733 auto returns = tp.submit_loop( 0, test_items.size(),
734 [&]( size_t i ) -> bool
735 {
736 BOARD_ITEM* item = test_items[ i ];
737
738 if( m_drcEngine->IsErrorLimitExceeded( DRCE_SOLDERMASK_BRIDGE ) )
739 return false;
740
741 BOX2I itemBBox = item->GetBoundingBox();
742
743 if( item->IsOnLayer( F_Mask ) && !isNullAperture( item ) )
744 {
745 // Test for aperture-to-aperture collisions
746 testItemAgainstItems( item, itemBBox, F_Mask, F_Mask );
747
748 // Test for aperture-to-zone collisions
749 testMaskItemAgainstZones( item, itemBBox, F_Mask, F_Cu );
750 }
751 else if( item->IsOnLayer( PADSTACK::ALL_LAYERS ) )
752 {
753 // Test for copper-item-to-aperture collisions
754 testItemAgainstItems( item, itemBBox, F_Cu, F_Mask );
755 }
756
757 if( item->IsOnLayer( B_Mask ) && !isNullAperture( item ) )
758 {
759 // Test for aperture-to-aperture collisions
760 testItemAgainstItems( item, itemBBox, B_Mask, B_Mask );
761
762 // Test for aperture-to-zone collisions
763 testMaskItemAgainstZones( item, itemBBox, B_Mask, B_Cu );
764 }
765 else if( item->IsOnLayer( B_Cu ) )
766 {
767 // Test for copper-item-to-aperture collisions
768 testItemAgainstItems( item, itemBBox, B_Cu, B_Mask );
769 }
770
771 ++count;
772
773 return true;
774 } );
775
776 for( auto& ret : returns )
777 {
778 if( !ret.valid() )
779 continue;
780
781 while( ret.wait_for( std::chrono::milliseconds( 100 ) ) == std::future_status::timeout )
782 reportProgress( count, test_items.size() );
783 }
784}
785
786
788{
789 if( m_drcEngine->IsErrorLimitExceeded( DRCE_SILK_MASK_CLEARANCE )
790 && m_drcEngine->IsErrorLimitExceeded( DRCE_SOLDERMASK_BRIDGE ) )
791 {
792 REPORT_AUX( wxT( "Solder mask violations ignored. Tests not run." ) );
793 return true; // continue with other tests
794 }
795
796 m_board = m_drcEngine->GetBoard();
797 m_webWidth = m_board->GetDesignSettings().m_SolderMaskMinWidth;
798 m_maxError = m_board->GetDesignSettings().m_MaxError;
800
801 auto updateLargestClearance =
802 [&]( int aClearance )
803 {
804 m_largestClearance = std::max( m_largestClearance, aClearance );
805 };
806
807 for( FOOTPRINT* footprint : m_board->Footprints() )
808 {
809 for( PAD* pad : footprint->Pads() )
810 updateLargestClearance( pad->GetSolderMaskExpansion( PADSTACK::ALL_LAYERS ) );
811
812 for( BOARD_ITEM* item : footprint->GraphicalItems() )
813 {
814 if( item->Type() == PCB_SHAPE_T )
815 updateLargestClearance( static_cast<PCB_SHAPE*>( item )->GetSolderMaskExpansion() );
816 }
817 }
818
819 for( PCB_TRACK* track : m_board->Tracks() )
820 updateLargestClearance( track->GetSolderMaskExpansion() );
821
822 for( BOARD_ITEM* item : m_board->Drawings() )
823 {
824 if( item->Type() == PCB_SHAPE_T )
825 updateLargestClearance( static_cast<PCB_SHAPE*>( item )->GetSolderMaskExpansion() );
826 }
827
828 // Order is important here: m_webWidth must be added in before m_largestCourtyardClearance is
829 // maxed with the various SILK_CLEARANCE_CONSTRAINTS.
831
832 DRC_CONSTRAINT worstClearanceConstraint;
833
834 if( m_drcEngine->QueryWorstConstraint( SILK_CLEARANCE_CONSTRAINT, worstClearanceConstraint ) )
835 m_largestClearance = std::max( m_largestClearance, worstClearanceConstraint.m_Value.Min() );
836
837 if( !reportPhase( _( "Building solder mask..." ) ) )
838 return false; // DRC cancelled
839
840 m_checkedPairs.clear();
841 m_maskApertureNetMap.clear();
842
843 buildRTrees();
844
845 if( !reportPhase( _( "Checking solder mask to silk clearance..." ) ) )
846 return false; // DRC cancelled
847
849
850 if( !reportPhase( _( "Checking solder mask web integrity..." ) ) )
851 return false; // DRC cancelled
852
854
855 return !m_drcEngine->IsCancelled();
856}
857
858
859namespace detail
860{
862}
@ ERROR_OUTSIDE
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:83
virtual bool IsConnected() const
Returns information if the object is derived from BOARD_CONNECTED_ITEM.
Definition board_item.h:138
virtual void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
Convert the item shape to a closed polygon.
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
Definition board_item.h:318
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:256
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:322
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition box2.h:558
constexpr bool Intersects(const BOX2< Vec > &aRect) const
Definition box2.h:311
wxString GetName() const
Definition drc_rule.h:194
SEVERITY GetSeverity() const
Definition drc_rule.h:207
const MINOPTMAX< int > & GetValue() const
Definition drc_rule.h:186
MINOPTMAX< int > m_Value
Definition drc_rule.h:228
DRC_RULE * GetParentRule() const
Definition drc_rule.h:190
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
Definition drc_item.cpp:400
Implement an R-tree for fast spatial and layer indexing of connectable items.
Definition drc_rtree.h:50
int QueryColliding(BOARD_ITEM *aRefItem, PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer, std::function< bool(BOARD_ITEM *)> aFilter=nullptr, std::function< bool(BOARD_ITEM *)> aVisitor=nullptr, int aClearance=0) const
This is a fast test which essentially does bounding-box overlap given a worst-case clearance.
Definition drc_rtree.h:217
virtual const wxString GetName() const override
void testMaskItemAgainstZones(BOARD_ITEM *item, const BOX2I &itemBBox, PCB_LAYER_ID refLayer, PCB_LAYER_ID targetLayer)
virtual ~DRC_TEST_PROVIDER_SOLDER_MASK()=default
bool checkMaskAperture(BOARD_ITEM *aMaskItem, BOARD_ITEM *aTestItem, PCB_LAYER_ID aTestLayer, int aTestNet, BOARD_ITEM **aCollidingItem)
std::unique_ptr< DRC_RTREE > m_fullSolderMaskRTree
virtual bool Run() override
Run this provider against the given PCB with configured options (if any).
std::unordered_map< PTR_PTR_CACHE_KEY, LSET > m_checkedPairs
bool checkItemMask(BOARD_ITEM *aItem, int aTestNet)
std::unordered_map< PTR_LAYER_CACHE_KEY, std::pair< BOARD_ITEM *, int > > m_maskApertureNetMap
void testItemAgainstItems(BOARD_ITEM *aItem, const BOX2I &aItemBBox, PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer)
static std::vector< KICAD_T > s_allBasicItemsButZones
virtual bool reportPhase(const wxString &aStageName)
int forEachGeometryItem(const std::vector< KICAD_T > &aTypes, const LSET &aLayers, const std::function< bool(BOARD_ITEM *)> &aFunc)
void reportViolation(std::shared_ptr< DRC_ITEM > &item, const VECTOR2I &aMarkerPos, int aMarkerLayer, const std::function< void(PCB_MARKER *)> &aPathGenerator=[](PCB_MARKER *){})
static std::vector< KICAD_T > s_allBasicItems
bool isInvisibleText(const BOARD_ITEM *aItem) const
wxString formatMsg(const wxString &aFormatString, const wxString &aSource, double aConstraint, double aActual, EDA_DATA_TYPE aDataType=EDA_DATA_TYPE::DISTANCE)
virtual bool reportProgress(size_t aCount, size_t aSize, size_t aDelta=1)
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition eda_item.cpp:110
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
bool AllowSolderMaskBridges() const
Definition footprint.h:333
std::map< wxString, int > MapPadNumbersToNetTieGroups() const
const std::set< int > & GetNetTieCache(const BOARD_ITEM *aItem) const
Get the set of net codes that are allowed to connect to a footprint item.
Definition footprint.h:556
bool IsNetTie() const
Definition footprint.h:340
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:591
T Min() const
Definition minoptmax.h:33
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
Definition padstack.h:177
Definition pad.h:55
const wxString & GetNumber() const
Definition pad.h:137
bool SameLogicalPadAs(const PAD *aOther) const
Before we had custom pad shapes it was common to have multiple overlapping pads to represent a more c...
Definition pad.h:160
int GetSolderMaskExpansion(PCB_LAYER_ID aLayer) const
Definition pad.cpp:1612
bool IsFreePad() const
Definition pad.cpp:332
bool SharesNetTieGroup(const PAD *aOther) const
Definition pad.cpp:309
int GetSolderMaskExpansion() const
bool IsTented(PCB_LAYER_ID aLayer) const override
Checks if the given object is tented (its copper shape is covered by solder mask) on a given side of ...
int GetSolderMaskExpansion() const
Represent a set of closed polygons.
void RemoveAllContours()
Remove all outlines & holes (clears) the polygon set.
void BooleanAdd(const SHAPE_POLY_SET &b)
Perform boolean polyset union.
void Simplify()
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections)
void Deflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError)
Handle a list of polygons defining a copper zone.
Definition zone.h:74
const std::shared_ptr< SHAPE_POLY_SET > & GetFilledPolysList(PCB_LAYER_ID aLayer) const
Definition zone.h:596
void CacheTriangulation(PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
Create a list of triangles that "fill" the solid areas used for instance to draw these solid areas on...
Definition zone.cpp:1305
const BOX2I GetBoundingBox() const override
Definition zone.cpp:613
void SetFillFlag(PCB_LAYER_ID aLayer, bool aFlag)
Definition zone.h:286
SHAPE_POLY_SET * GetFill(PCB_LAYER_ID aLayer)
Definition zone.h:602
void SetIsFilled(bool isFilled)
Definition zone.h:289
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition zone.h:136
The common library.
@ CHAMFER_ALL_CORNERS
All angles are chamfered.
@ DRCE_SILK_MASK_CLEARANCE
Definition drc_item.h:97
@ DRCE_SOLDERMASK_BRIDGE
Definition drc_item.h:94
@ BRIDGED_MASK_CONSTRAINT
Definition drc_rule.h:83
@ SILK_CLEARANCE_CONSTRAINT
Definition drc_rule.h:56
#define REPORT_AUX(s)
bool isMaskAperture(BOARD_ITEM *aItem)
bool isNullAperture(BOARD_ITEM *aItem)
#define _(s)
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
Definition layer_ids.h:780
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ B_Mask
Definition layer_ids.h:98
@ B_Cu
Definition layer_ids.h:65
@ F_Mask
Definition layer_ids.h:97
@ F_SilkS
Definition layer_ids.h:100
@ B_SilkS
Definition layer_ids.h:101
@ F_Cu
Definition layer_ids.h:64
static DRC_REGISTER_TEST_PROVIDER< DRC_TEST_PROVIDER_ANNULAR_WIDTH > dummy
@ NPTH
like PAD_PTH, but not plated mechanical use only, no connection allowed
Definition padstack.h:103
@ RPT_SEVERITY_IGNORE
int clearance
int actual
thread_pool & GetKiCadThreadPool()
Get a reference to the current thread pool.
static thread_pool * tp
BS::priority_thread_pool thread_pool
Definition thread_pool.h:31
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition typeinfo.h:88
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:97
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:108
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:92
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition typeinfo.h:90
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:87
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695