KiCad PCB EDA Suite
export_d356.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 (C) 2011-2013 Lorenzo Marcantonio <[email protected]>
5 * Copyright (C) 2004-2022 KiCad Developers, see change_log.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
30#include <confirm.h>
31#include <gestfich.h>
32#include <kiface_base.h>
33#include <pcb_edit_frame.h>
34#include <trigo.h>
35#include <build_version.h>
36#include <macros.h>
38#include <locale_io.h>
39#include <pcbnew.h>
40#include <board.h>
42#include <footprint.h>
43#include <pad.h>
44#include <pcb_track.h>
45#include <vector>
46#include <cctype>
47#include <math/util.h> // for KiROUND
48#include <export_d356.h>
49#include <wx/filedlg.h>
50
51
52
53// Compute the access code for a pad. Returns -1 if there is no copper
54static int compute_pad_access_code( BOARD *aPcb, LSET aLayerMask )
55{
56 // Non-copper is not interesting here
57 aLayerMask &= LSET::AllCuMask();
58 if( !aLayerMask.any() )
59 return -1;
60
61 // Traditional TH pad
62 if( aLayerMask[F_Cu] && aLayerMask[B_Cu] )
63 return 0;
64
65 // Front SMD pad
66 if( aLayerMask[F_Cu] )
67 return 1;
68
69 // Back SMD pad
70 if( aLayerMask[B_Cu] )
71 return aPcb->GetCopperLayerCount();
72
73 // OK, we have an inner-layer only pad (and I have no idea about
74 // what could be used for); anyway, find the first copper layer
75 // it's on
76 for( int layer = In1_Cu; layer < B_Cu; ++layer )
77 {
78 if( aLayerMask[layer] )
79 return layer + 1;
80 }
81
82 // This shouldn't happen
83 return -1;
84}
85
86/* Convert and clamp a size from IU to decimils */
87static int iu_to_d356(int iu, int clamp)
88{
89 int val = KiROUND( iu / ( pcbIUScale.IU_PER_MILS / 10 ) );
90 if( val > clamp ) return clamp;
91 if( val < -clamp ) return -clamp;
92 return val;
93}
94
95/* Extract the D356 record from the footprints (pads) */
96static void build_pad_testpoints( BOARD *aPcb, std::vector <D356_RECORD>& aRecords )
97{
98 VECTOR2I origin = aPcb->GetDesignSettings().GetAuxOrigin();
99
100 for( FOOTPRINT* footprint : aPcb->Footprints() )
101 {
102 for( PAD* pad : footprint->Pads() )
103 {
104 D356_RECORD rk;
105 rk.access = compute_pad_access_code( aPcb, pad->GetLayerSet() );
106
107 // It could be a mask only pad, we only handle pads with copper here
108 if( rk.access != -1 )
109 {
110 rk.netname = pad->GetNetname();
111 rk.pin = pad->GetNumber();
112 rk.refdes = footprint->GetReference();
113 rk.midpoint = false; // XXX MAYBE need to be computed (how?)
114 const VECTOR2I& drill = pad->GetDrillSize();
115 rk.drill = std::min( drill.x, drill.y );
116 rk.hole = (rk.drill != 0);
117 rk.smd = pad->GetAttribute() == PAD_ATTRIB::SMD
118 || pad->GetAttribute() == PAD_ATTRIB::CONN;
119 rk.mechanical = ( pad->GetAttribute() == PAD_ATTRIB::NPTH );
120 rk.x_location = pad->GetPosition().x - origin.x;
121 rk.y_location = origin.y - pad->GetPosition().y;
122 rk.x_size = pad->GetSize().x;
123
124 // Rule: round pads have y = 0
125 if( pad->GetShape() == PAD_SHAPE::CIRCLE )
126 rk.y_size = 0;
127 else
128 rk.y_size = pad->GetSize().y;
129
130 rk.rotation = - pad->GetOrientation().AsDegrees();
131
132 if( rk.rotation < 0 )
133 rk.rotation += 360;
134
135 // the value indicates which sides are *not* accessible
136 rk.soldermask = 3;
137
138 if( pad->GetLayerSet()[F_Mask] )
139 rk.soldermask &= ~1;
140
141 if( pad->GetLayerSet()[B_Mask] )
142 rk.soldermask &= ~2;
143
144 aRecords.push_back( rk );
145 }
146 }
147 }
148}
149
150/* Compute the access code for a via. In D-356 layers are numbered from 1 up,
151 where '1' is the 'primary side' (usually the component side);
152 '0' means 'both sides', and other layers follows in an unspecified order */
153static int via_access_code( BOARD *aPcb, int top_layer, int bottom_layer )
154{
155 // Easy case for through vias: top_layer is component, bottom_layer is
156 // solder, access code is 0
157 if( (top_layer == F_Cu) && (bottom_layer == B_Cu) )
158 return 0;
159
160 // Blind via, reachable from front
161 if( top_layer == F_Cu )
162 return 1;
163
164 // Blind via, reachable from bottom
165 if( bottom_layer == B_Cu )
166 return aPcb->GetCopperLayerCount();
167
168 // It's a buried via, accessible from some inner layer
169 // (maybe could be used for testing before laminating? no idea)
170 return bottom_layer + 1; // XXX is this correct?
171}
172
173/* Extract the D356 record from the vias */
174static void build_via_testpoints( BOARD *aPcb, std::vector <D356_RECORD>& aRecords )
175{
176 VECTOR2I origin = aPcb->GetDesignSettings().GetAuxOrigin();
177
178 // Enumerate all the track segments and keep the vias
179 for( auto track : aPcb->Tracks() )
180 {
181 if( track->Type() == PCB_VIA_T )
182 {
183 PCB_VIA *via = static_cast<PCB_VIA*>( track );
184 NETINFO_ITEM *net = track->GetNet();
185
186 D356_RECORD rk;
187 rk.smd = false;
188 rk.hole = true;
189 if( net )
190 rk.netname = net->GetNetname();
191 else
192 rk.netname = wxEmptyString;
193 rk.refdes = wxT("VIA");
194 rk.pin = wxT("");
195 rk.midpoint = true; // Vias are always midpoints
196 rk.drill = via->GetDrillValue();
197 rk.mechanical = false;
198
199 PCB_LAYER_ID top_layer, bottom_layer;
200
201 via->LayerPair( &top_layer, &bottom_layer );
202
203 rk.access = via_access_code( aPcb, top_layer, bottom_layer );
204 rk.x_location = via->GetPosition().x - origin.x;
205 rk.y_location = origin.y - via->GetPosition().y;
206 rk.x_size = via->GetWidth();
207 rk.y_size = 0; // Round so height = 0
208 rk.rotation = 0;
209 rk.soldermask = 3; // XXX always tented?
210
211 aRecords.push_back( rk );
212 }
213 }
214}
215
216/* Add a new netname to the d356 canonicalized list */
217static const wxString intern_new_d356_netname( const wxString &aNetname,
218 std::map<wxString, wxString> &aMap, std::set<wxString> &aSet )
219{
220 wxString canon;
221
222 for( size_t ii = 0; ii < aNetname.Len(); ++ii )
223 {
224 // Rule: we can only use the standard ASCII, control excluded
225 wxUniChar ch = aNetname[ii];
226
227 if( ch > 126 || !std::isgraph( static_cast<unsigned char>( ch ) ) )
228 ch = '?';
229
230 canon += ch;
231 }
232
233 // Rule: only uppercase (unofficial, but known to give problems
234 // otherwise)
235 canon.MakeUpper();
236
237 // Rule: maximum length is 14 characters, otherwise we keep the tail
238 if( canon.size() > 14 )
239 {
240 canon = canon.Right( 14 );
241 }
242
243 // Check if it's still unique
244 if( aSet.count( canon ) )
245 {
246 // Nope, need to uniquify it, trim it more and add a number
247 wxString base( canon );
248 if( base.size() > 10 )
249 {
250 base = base.Right( 10 );
251 }
252
253 int ctr = 0;
254 do
255 {
256 ++ctr;
257 canon = base;
258 canon << '#' << ctr;
259 } while ( aSet.count( canon ) );
260 }
261
262 // Register it
263 aMap[aNetname] = canon;
264 aSet.insert( canon );
265 return canon;
266}
267
268/* Write all the accumuled data to the file in D356 format */
269void IPC356D_WRITER::write_D356_records( std::vector <D356_RECORD> &aRecords, FILE* aFile )
270{
271 // Sanified and shorted network names and set of short names
272 std::map<wxString, wxString> d356_net_map;
273 std::set<wxString> d356_net_set;
274
275 for( unsigned i = 0; i < aRecords.size(); i++ )
276 {
277 D356_RECORD &rk = aRecords[i];
278
279 // Try to sanify the network name (there are limits on this), if
280 // not already done. Also 'empty' net are marked as N/C, as
281 // specified.
282 wxString d356_net( wxT( "N/C" ) );
283
284 if( !rk.netname.empty() )
285 {
286 d356_net = d356_net_map[rk.netname];
287
288 if( d356_net.empty() )
289 d356_net = intern_new_d356_netname( rk.netname, d356_net_map, d356_net_set );
290 }
291
292 // Choose the best record type
293 int rktype;
294
295 if( rk.smd )
296 rktype = 327;
297 else
298 {
299 if( rk.mechanical )
300 rktype = 367;
301 else
302 rktype = 317;
303 }
304
305 // Operation code, signal and component
306 fprintf( aFile, "%03d%-14.14s %-6.6s%c%-4.4s%c",
307 rktype, TO_UTF8(d356_net),
308 TO_UTF8(rk.refdes),
309 rk.pin.empty()?' ':'-',
310 TO_UTF8(rk.pin),
311 rk.midpoint?'M':' ' );
312
313 // Hole definition
314 if( rk.hole )
315 {
316 fprintf( aFile, "D%04d%c",
317 iu_to_d356( rk.drill, 9999 ),
318 rk.mechanical ? 'U':'P' );
319 }
320 else
321 fprintf( aFile, " " );
322
323 // Test point access
324 fprintf( aFile, "A%02dX%+07dY%+07dX%04dY%04dR%03d",
325 rk.access,
326 iu_to_d356( rk.x_location, 999999 ),
327 iu_to_d356( rk.y_location, 999999 ),
328 iu_to_d356( rk.x_size, 9999 ),
329 iu_to_d356( rk.y_size, 9999 ),
330 rk.rotation );
331
332 // Soldermask
333 fprintf( aFile, "S%d\n", rk.soldermask );
334 }
335}
336
337
338void IPC356D_WRITER::Write( const wxString& aFilename )
339{
340 FILE* file = nullptr;
341 LOCALE_IO toggle; // Switch the locale to standard C
342
343 if( ( file = wxFopen( aFilename, wxT( "wt" ) ) ) == nullptr )
344 {
345 wxString details;
346 details.Printf( wxT( "The file %s could not be opened for writing." ), aFilename );
347 DisplayErrorMessage( m_parent, wxT( "Could not write IPC-356D file!" ), details );
348 return;
349 }
350
351 // This will contain everything needed for the 356 file
352 std::vector<D356_RECORD> d356_records;
353
354 build_via_testpoints( m_pcb, d356_records );
355
356 build_pad_testpoints( m_pcb, d356_records );
357
358 // Code 00 AFAIK is ASCII, CUST 0 is decimils/degrees
359 // CUST 1 would be metric but gerbtool simply ignores it!
360 fprintf( file, "P CODE 00\n" );
361 fprintf( file, "P UNITS CUST 0\n" );
362 fprintf( file, "P arrayDim N\n" );
363 write_D356_records( d356_records, file );
364 fprintf( file, "999\n" );
365
366 fclose( file );
367}
368
369
370void PCB_EDIT_FRAME::GenD356File( wxCommandEvent& aEvent )
371{
372 wxFileName fn = GetBoard()->GetFileName();
373 wxString ext, wildcard;
374
376 wildcard = IpcD356FileWildcard();
377 fn.SetExt( ext );
378
379 wxString pro_dir = wxPathOnly( Prj().GetProjectFullName() );
380
381 wxFileDialog dlg( this, _( "Export D-356 Test File" ), pro_dir,
382 fn.GetFullName(), wildcard,
383 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
384
385 if( dlg.ShowModal() == wxID_CANCEL )
386 return;
387
388 IPC356D_WRITER writer( GetBoard(), this );
389
390 writer.Write( dlg.GetPath() );
391}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:109
const VECTOR2I & GetAuxOrigin()
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
FOOTPRINTS & Footprints()
Definition: board.h:307
int GetCopperLayerCount() const
Definition: board.cpp:489
TRACKS & Tracks()
Definition: board.h:304
const wxString & GetFileName() const
Definition: board.h:302
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:618
Wrapper to expose an API for writing IPC-D356 files.
Definition: export_d356.h:54
void Write(const wxString &aFilename)
Generates and writes the netlist to a given path.
wxWindow * m_parent
Definition: export_d356.h:75
void write_D356_records(std::vector< D356_RECORD > &aRecords, FILE *aFile)
Writes a list of records to the given output stream.
BOARD * m_pcb
Definition: export_d356.h:74
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:530
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:773
Handle the data for a net.
Definition: netinfo.h:66
const wxString & GetNetname() const
Definition: netinfo.h:119
Definition: pad.h:58
BOARD * GetBoard() const
void GenD356File(wxCommandEvent &event)
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:299
This file is part of the common library.
#define _(s)
static void build_pad_testpoints(BOARD *aPcb, std::vector< D356_RECORD > &aRecords)
Definition: export_d356.cpp:96
static void build_via_testpoints(BOARD *aPcb, std::vector< D356_RECORD > &aRecords)
static int iu_to_d356(int iu, int clamp)
Definition: export_d356.cpp:87
static const wxString intern_new_d356_netname(const wxString &aNetname, std::map< wxString, wxString > &aMap, std::set< wxString > &aSet)
static int via_access_code(BOARD *aPcb, int top_layer, int bottom_layer)
static int compute_pad_access_code(BOARD *aPcb, LSET aLayerMask)
Definition: export_d356.cpp:54
const std::string IpcD356FileExtension
wxString IpcD356FileWildcard()
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:59
@ B_Mask
Definition: layer_ids.h:106
@ B_Cu
Definition: layer_ids.h:95
@ F_Mask
Definition: layer_ids.h:107
@ In1_Cu
Definition: layer_ids.h:65
@ F_Cu
Definition: layer_ids.h:64
This file contains miscellaneous commonly used macros and functions.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
@ NPTH
like PAD_PTH, but not plated
@ SMD
Smd pad, appears on the solder paste layer (default)
@ CONN
Like smd, does not appear on the solder paste layer (default)
int x_location
Definition: export_d356.h:42
wxString refdes
Definition: export_d356.h:34
bool midpoint
Definition: export_d356.h:36
bool mechanical
Definition: export_d356.h:38
int y_location
Definition: export_d356.h:43
wxString pin
Definition: export_d356.h:35
int soldermask
Definition: export_d356.h:40
wxString netname
Definition: export_d356.h:33
const double IU_PER_MILS
Definition: base_units.h:78
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:102
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:80
Definition of file extensions used in Kicad.