/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2007-2008 SoftPLC Corporation, Dick Hollenbeck * Copyright (C) 2007 KiCad Developers, see change_log.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 */ /* This source is a complement to specctra.cpp and implements the export to specctra dsn file format. The specification for the grammar of the specctra dsn file used to develop this code is given here: http://tech.groups.yahoo.com/group/kicad-users/files/ then file "specctra.pdf" Also see the comments at the top of the specctra.cpp file itself. */ #include #include // HISTORY_NUMBER #include // DisplayError() #include // EDA_FileSelector() #include // RotatePoint() #include // std::set #include // std::map #include // boost::addressof() #include #include #include #include #include #include #include #include #include using namespace DSN; // Add .1 mil to the requested clearances as a safety margin. // There has been disagreement about interpretation of clearance in the past // between KiCad and Freerouter, so keep this safetyMargin until the // disagreement is resolved and stable. Freerouter seems to be moving // (protected) traces upon loading the DSN file, and even though it seems to sometimes // add its own 0.1 to the clearances, I believe this is happening after // the load process (and moving traces) so I am of the opinion this is // still needed. static const double safetyMargin = 0.1; // see wxPcbStruct.h void PCB_EDIT_FRAME::ExportToSpecctra( wxCommandEvent& event ) { wxString fullFileName = GetBoard()->GetFileName(); wxString path; wxString name; wxString ext; wxString dsn_ext = wxT( ".dsn" ); wxString mask = wxT( "*" ) + dsn_ext; wxFileName::SplitPath( fullFileName, &path, &name, &ext ); name += dsn_ext; fullFileName = EDA_FileSelector( _( "Specctra DSN file:" ), path, name, // name.ext without path! dsn_ext, mask, this, wxFD_SAVE, false ); if( fullFileName == wxEmptyString ) return; SPECCTRA_DB db; bool ok = true; wxString errorText; BASE_SCREEN* screen = GetScreen(); bool wasModified = screen->IsModify(); db.SetPCB( SPECCTRA_DB::MakePCB() ); SetLocaleTo_C_standard( ); // Switch the locale to standard C // DSN Images (=KiCad MODULES and pads) must be presented from the // top view. So we temporarily flip any modules which are on the back // side of the board to the front, and record this in the MODULE's flag field. db.FlipMODULEs( GetBoard() ); try { GetBoard()->SynchronizeNetsAndNetClasses(); db.FromBOARD( GetBoard() ); db.ExportPCB( fullFileName, true ); // if an exception is thrown by FromBOARD or ExportPCB(), then // ~SPECCTRA_DB() will close the file. } catch( IO_ERROR& ioe ) { ok = false; // copy the error string to safe place, ioe is in this scope only. errorText = ioe.errorText; } SetLocaleTo_Default( ); // revert to the current locale // done assuredly, even if an exception was thrown and caught. db.RevertMODULEs( GetBoard() ); // The two calls below to MODULE::Flip(), both set the // modified flag, yet their actions cancel each other out, so it should // be ok to clear the modify flag. if( !wasModified ) screen->ClrModify(); if( ok ) { SetStatusText( wxString( _( "BOARD exported OK." ) ) ); } else { errorText += '\n'; errorText += _( "Unable to export, please fix and try again." ); DisplayError( this, errorText ); } } namespace DSN { const KICAD_T SPECCTRA_DB::scanPADs[] = { PCB_PAD_T, EOT }; // "specctra reported units" are what we tell the external router that our // exported lengths are in. /** * Function scale * converts a distance from PCBNEW internal units to the reported specctra dsn units * in floating point format. */ static inline double scale( int kicadDist ) { #if defined(USE_PCBNEW_NANOMETRES) // nanometers to um return kicadDist / ( IU_PER_MM / 1000.0 ); // nanometers to mils // return kicadDist/IU_PER_MILS; #else // deci-mils to mils. return kicadDist/10.0; #endif } /// Convert integer internal units to float um static inline double IU2um( int kicadDist ) { return kicadDist * (1000.0 / IU_PER_MM); } static inline double mapX( int x ) { return scale(x); } static inline double mapY( int y ) { return -scale(y); // make y negative, since it is increasing going down. } /** * Function mapPt * converts a KiCad point into a DSN file point. Kicad's BOARD coordinates * are in deci-mils (i.e. 1/10,000th of an inch) and we are exporting in units * of mils, so we have to divide by 10. */ static POINT mapPt( const wxPoint& pt ) { POINT ret; ret.x = mapX( pt.x ); ret.y = mapY( pt.y ); ret.FixNegativeZero(); return ret; } /** * Function findPoint * searches for a DRAWSEGMENT with an end point or start point of aPoint, and * if found, removes it from the TYPE_COLLECTOR and returns it, else returns NULL. * @param aPoint The starting or ending point to search for. * @param items The list to remove from. * @return DRAWSEGMENT* - The first DRAWSEGMENT that has a start or end point matching * aPoint, otherwise NULL if none. */ static DRAWSEGMENT* findPoint( const wxPoint& aPoint, TYPE_COLLECTOR* items ) { for( int i=0; iGetCount(); ++i ) { DRAWSEGMENT* graphic = (DRAWSEGMENT*) (*items)[i]; wxASSERT( graphic->Type() == PCB_LINE_T ); switch( graphic->GetShape() ) { case S_ARC: if( aPoint == graphic->GetArcStart() || aPoint == graphic->GetArcEnd() ) { items->Remove(i); return graphic; } break; default: if( aPoint == graphic->GetStart() || aPoint == graphic->GetEnd() ) { items->Remove(i); return graphic; } } } #if defined(DEBUG) printf("Unable to find segment matching point (%d,%d)\n", aPoint.x, aPoint.y ); for( int i=0; iGetCount(); ++i ) { DRAWSEGMENT* graphic = (DRAWSEGMENT*) (*items)[i]; printf( "type=%s, GetStart()=%d,%d GetEnd()=%d,%d\n", TO_UTF8( BOARD_ITEM::ShowShape( (STROKE_T) graphic->GetShape() ) ), graphic->GetStart().x, graphic->GetStart().y, graphic->GetEnd().x, graphic->GetEnd().y ); } #endif return NULL; } /** * Function isRoundKeepout * decides if the pad is a copper-less through hole which needs to be made into * a round keepout. */ static bool isRoundKeepout( D_PAD* aPad ) { if( aPad->GetShape()==PAD_CIRCLE ) { if( aPad->GetDrillSize().x >= aPad->GetSize().x ) return true; if( (aPad->GetLayerMask() & ALL_CU_LAYERS) == 0 ) return true; } return false; } /** * Function makePath * creates a PATH element with a single straight line, a pair of vertices. */ static PATH* makePath( const POINT& aStart, const POINT& aEnd, const std::string& aLayerName ) { PATH* path = new PATH( 0, T_path ); path->AppendPoint( aStart ); path->AppendPoint( aEnd ); path->SetLayerId( aLayerName.c_str() ); return path; } PADSTACK* SPECCTRA_DB::makePADSTACK( BOARD* aBoard, D_PAD* aPad ) { char name[256]; // padstack name builder std::string uniqifier; // caller must do these checks before calling here. wxASSERT( !isRoundKeepout( aPad ) ); PADSTACK* padstack = new PADSTACK(); int reportedLayers = 0; // how many in reported padstack const char* layerName[NB_COPPER_LAYERS]; uniqifier = '['; bool onAllCopperLayers = ( (aPad->GetLayerMask() & ALL_CU_LAYERS) == ALL_CU_LAYERS ); if( onAllCopperLayers ) uniqifier += 'A'; // A for all layers const int copperCount = aBoard->GetCopperLayerCount(); for( LAYER_NUM layer=FIRST_LAYER; layerIsOnLayer( kilayer ) ) { layerName[reportedLayers++] = layerIds[layer].c_str(); if( !onAllCopperLayers ) { if( layer == 0 ) uniqifier += 'T'; else if( layer == copperCount-1 ) uniqifier += 'B'; else uniqifier += char('0' + layer); // layer index char } } } uniqifier += ']'; POINT dsnOffset; if( aPad->GetOffset().x || aPad->GetOffset().y ) { char offsetTxt[64]; wxPoint offset( aPad->GetOffset().x, aPad->GetOffset().y ); dsnOffset = mapPt( offset ); // using '(' or ')' would cause padstack name to be quote wrapped, // so use other brackets, and {} locks freerouter. sprintf( offsetTxt, "[%.6g,%.6g]", dsnOffset.x, dsnOffset.y ); uniqifier += offsetTxt; } switch( aPad->GetShape() ) { default: case PAD_CIRCLE: { double diameter = scale(aPad->GetSize().x); for( LAYER_NUM ndx=FIRST_LAYER; ndxAppend( shape ); CIRCLE* circle = new CIRCLE( shape ); shape->SetShape( circle ); circle->SetLayerId( layerName[ndx] ); circle->SetDiameter( diameter ); circle->SetVertex( dsnOffset ); } snprintf( name, sizeof(name), "Round%sPad_%.6g_um", uniqifier.c_str(), IU2um( aPad->GetSize().x ) ); name[ sizeof(name)-1 ] = 0; padstack->SetPadstackId( name ); } break; case PAD_RECT: { double dx = scale( aPad->GetSize().x ) / 2.0; double dy = scale( aPad->GetSize().y ) / 2.0; POINT lowerLeft( -dx, -dy ); POINT upperRight( dx, dy ); lowerLeft += dsnOffset; upperRight += dsnOffset; for( LAYER_NUM ndx=FIRST_LAYER; ndxAppend( shape ); RECTANGLE* rect = new RECTANGLE( shape ); shape->SetShape( rect ); rect->SetLayerId( layerName[ndx] ); rect->SetCorners( lowerLeft, upperRight ); } snprintf( name, sizeof(name), "Rect%sPad_%.6gx%.6g_um", uniqifier.c_str(), IU2um( aPad->GetSize().x ), IU2um( aPad->GetSize().y ) ); name[ sizeof(name)-1 ] = 0; padstack->SetPadstackId( name ); } break; case PAD_OVAL: { double dx = scale( aPad->GetSize().x ) / 2.0; double dy = scale( aPad->GetSize().y ) / 2.0; double dr = dx - dy; double radius; POINT start; POINT stop; if( dr >= 0 ) // oval is horizontal { radius = dy; start = POINT( -dr, 0.0 ); stop = POINT( dr, 0.0 ); } else // oval is vertical { radius = dx; dr = -dr; start = POINT( 0.0, -dr ); stop = POINT( 0.0, dr ); } start += dsnOffset; stop += dsnOffset; for( LAYER_NUM ndx=FIRST_LAYER; ndxAppend( shape ); path = makePath( start, stop, layerName[ndx] ); shape->SetShape( path ); path->aperture_width = 2.0 * radius; } snprintf( name, sizeof(name), "Oval%sPad_%.6gx%.6g_um", uniqifier.c_str(), IU2um( aPad->GetSize().x ), IU2um( aPad->GetSize().y ) ); name[ sizeof(name)-1 ] = 0; padstack->SetPadstackId( name ); } break; case PAD_TRAPEZOID: { double dx = scale( aPad->GetSize().x ) / 2.0; double dy = scale( aPad->GetSize().y ) / 2.0; double ddx = scale( aPad->GetDelta().x ) / 2.0; double ddy = scale( aPad->GetDelta().y ) / 2.0; // see class_pad_draw_functions.cpp which draws the trapezoid pad POINT lowerLeft( -dx - ddy, -dy - ddx ); POINT upperLeft( -dx + ddy, +dy + ddx ); POINT upperRight( +dx - ddy, +dy - ddx ); POINT lowerRight( +dx + ddy, -dy + ddx ); lowerLeft += dsnOffset; upperLeft += dsnOffset; upperRight += dsnOffset; lowerRight += dsnOffset; for( LAYER_NUM ndx=FIRST_LAYER; ndxAppend( shape ); // a T_polygon exists as a PATH PATH* polygon = new PATH( shape, T_polygon ); shape->SetShape( polygon ); polygon->SetLayerId( layerName[ndx] ); polygon->AppendPoint( lowerLeft ); polygon->AppendPoint( upperLeft ); polygon->AppendPoint( upperRight ); polygon->AppendPoint( lowerRight ); } D(printf( "m_DeltaSize: %d,%d\n", aPad->GetDelta().x, aPad->GetDelta().y );) // this string _must_ be unique for a given physical shape snprintf( name, sizeof(name), "Trapz%sPad_%.6gx%.6g_%c%.6gx%c%.6g_um", uniqifier.c_str(), IU2um( aPad->GetSize().x ), IU2um( aPad->GetSize().y ), aPad->GetDelta().x < 0 ? 'n' : 'p', std::abs( IU2um( aPad->GetDelta().x )), aPad->GetDelta().y < 0 ? 'n' : 'p', std::abs( IU2um( aPad->GetDelta().y ) ) ); name[ sizeof(name)-1 ] = 0; padstack->SetPadstackId( name ); } break; } return padstack; } /// data type used to ensure unique-ness of pin names, holding (wxString and int) typedef std::map PINMAP; IMAGE* SPECCTRA_DB::makeIMAGE( BOARD* aBoard, MODULE* aModule ) { PINMAP pinmap; TYPE_COLLECTOR moduleItems; wxString padName; // get all the MODULE's pads. moduleItems.Collect( aModule, scanPADs ); IMAGE* image = new IMAGE(0); image->image_id = TO_UTF8( aModule->GetLibRef() ); // from the pads, and make an IMAGE using collated padstacks. for( int p=0; pGetDrillSize().x ); POINT vertex = mapPt( pad->GetPos0() ); int layerCount = aBoard->GetCopperLayerCount(); for( LAYER_NUM layer=FIRST_LAYER; layerkeepouts.push_back( keepout ); CIRCLE* circle = new CIRCLE( keepout ); keepout->SetShape( circle ); circle->SetDiameter( diameter ); circle->SetVertex( vertex ); circle->SetLayerId( layerIds[layer].c_str() ); } } // else if() could there be a square keepout here? else { PADSTACK* padstack = makePADSTACK( aBoard, pad ); PADSTACKSET::iterator iter = padstackset.find( *padstack ); if( iter != padstackset.end() ) { // padstack is a duplicate, delete it and use the original delete padstack; padstack = (PADSTACK*) *iter.base(); // folklore, be careful here } else { padstackset.insert( padstack ); } PIN* pin = new PIN(image); padName = pad->GetPadName(); pin->pin_id = TO_UTF8( padName ); if( padName!=wxEmptyString && pinmap.find( padName )==pinmap.end() ) { pinmap[ padName ] = 0; } else // pad name is a duplicate within this module { char buf[32]; int duplicates = ++pinmap[ padName ]; sprintf( buf, "@%d", duplicates ); pin->pin_id += buf; // append "@1" or "@2", etc. to pin name } pin->kiNetCode = pad->GetNet(); image->pins.push_back( pin ); pin->padstack_id = padstack->padstack_id; int angle = pad->GetOrientation() - aModule->GetOrientation(); // tenths of degrees if( angle ) { NORMALIZE_ANGLE_POS(angle); pin->SetRotation( angle / 10.0 ); } wxPoint pos( pad->GetPos0() ); pin->SetVertex( mapPt( pos ) ); } } #if 1 // enable image (outline) scopes. static const KICAD_T scanEDGEs[] = { PCB_MODULE_EDGE_T, EOT }; // get all the MODULE's EDGE_MODULEs and convert those to DSN outlines. moduleItems.Collect( aModule, scanEDGEs ); for( int i=0; iGetShape() ) { case S_SEGMENT: outline = new SHAPE( image, T_outline ); image->Append( outline ); path = new PATH( outline ); outline->SetShape( path ); path->SetAperture( scale( graphic->GetWidth() ) ); path->SetLayerId( "signal" ); path->AppendPoint( mapPt( graphic->GetStart0() ) ); path->AppendPoint( mapPt( graphic->GetEnd0() ) ); break; case S_CIRCLE: { // this is best done by 4 QARC's but freerouter does not yet support QARCs. // for now, support by using line segments. outline = new SHAPE( image, T_outline ); image->Append( outline ); path = new PATH( outline ); outline->SetShape( path ); path->SetAperture( scale( graphic->GetWidth() ) ); path->SetLayerId( "signal" ); // Do the math using KiCad units, that way we stay out of the // scientific notation range of floating point numbers in the // DSN file. We do not parse scientific notation in our own // lexer/beautifier, and the spec is not clear that this is // required. Fixed point floats are all that should be needed. double radius = hypot( double( graphic->GetStart().x - graphic->GetEnd().x ), double( graphic->GetStart().y - graphic->GetEnd().y ) ); // better if evenly divisible into 360 const int DEGREE_INTERVAL = 18; // 18 means 20 line segments for( double radians = 0.0; radians < 2*M_PI; radians += DEGREE_INTERVAL * M_PI / 180.0 ) { wxPoint point( int( radius * cos( radians ) ), int( radius * sin( radians ) ) ); point += graphic->m_Start0; // an offset path->AppendPoint( mapPt(point) ); } } break; case S_RECT: case S_ARC: default: D( printf("makeIMAGE(): unsupported shape %s\n", TO_UTF8( BOARD_ITEM::ShowShape( (STROKE_T) graphic->GetShape() )) );) continue; } } #endif return image; } PADSTACK* SPECCTRA_DB::makeVia( int aCopperDiameter, int aDrillDiameter, LAYER_NUM aTopLayer, LAYER_NUM aBotLayer ) { char name[48]; PADSTACK* padstack = new PADSTACK(); double dsnDiameter = scale( aCopperDiameter ); for( LAYER_NUM layer=aTopLayer; layer<=aBotLayer; ++layer ) { SHAPE* shape = new SHAPE( padstack ); padstack->Append( shape ); CIRCLE* circle = new CIRCLE( shape ); shape->SetShape( circle ); circle->SetDiameter( dsnDiameter ); circle->SetLayerId( layerIds[layer].c_str() ); } snprintf( name, sizeof(name), "Via[%d-%d]_%.6g:%.6g_um", aTopLayer, aBotLayer, dsnDiameter, // encode the drill value into the name for later import IU2um( aDrillDiameter ) ); name[ sizeof(name)-1 ] = 0; padstack->SetPadstackId( name ); return padstack; } PADSTACK* SPECCTRA_DB::makeVia( const SEGVIA* aVia ) { LAYER_NUM topLayer; LAYER_NUM botLayer; aVia->ReturnLayerPair( &topLayer, &botLayer ); topLayer = kicadLayer2pcb[topLayer]; botLayer = kicadLayer2pcb[botLayer]; if( topLayer > botLayer ) EXCHG( topLayer, botLayer ); return makeVia( aVia->GetWidth(), aVia->GetDrillValue(), topLayer, botLayer ); } void SPECCTRA_DB::fillBOUNDARY( BOARD* aBoard, BOUNDARY* boundary ) throw( IO_ERROR ) { TYPE_COLLECTOR items; // get all the DRAWSEGMENTS into 'items', then look for layer == EDGE_N, // and those segments comprise the board's perimeter. static const KICAD_T scan_graphics[] = { PCB_LINE_T, PCB_MODULE_EDGE_T, EOT }; items.Collect( aBoard, scan_graphics ); for( int i=0; iGetLayer() != EDGE_N ) { items.Remove( i ); } else // remove graphics not on EDGE_N layer { ++i; D( items[i]->Show( 0, std::cout );) } } if( items.GetCount() ) { PATH* path = new PATH( boundary ); boundary->paths.push_back( path ); path->layer_id = "pcb"; wxPoint prevPt; DRAWSEGMENT* graphic = (DRAWSEGMENT*) items[0]; // the first DRAWSEGMENT is in 'graphic*', ok to remove it from 'items' items.Remove( 0 ); prevPt = graphic->GetEnd(); path->AppendPoint( mapPt( prevPt ) ); // do not append the other end point yet, this first 'graphic' might be an arc for(;;) { switch( graphic->GetShape() ) { case S_SEGMENT: { wxPoint nextPt; if( prevPt != graphic->GetStart() ) { wxASSERT( prevPt == graphic->GetEnd() ); nextPt = graphic->GetStart(); } else { wxASSERT( prevPt == graphic->GetStart() ); nextPt = graphic->GetEnd(); } path->AppendPoint( mapPt(nextPt) ); prevPt = nextPt; } break; case S_ARC: // freerouter does not yet understand arcs, so approximate // an arc with a series of short lines and put those // line segments into the !same! PATH. { const int STEPS = 9; // in an arc of 90 degrees wxPoint start = graphic->GetArcStart(); wxPoint end = graphic->GetArcEnd(); wxPoint center = graphic->GetCenter(); double angle = -graphic->GetAngle(); if( prevPt != start ) { wxASSERT( prevPt == graphic->GetArcEnd() ); angle = -angle; EXCHG( start, end ); } wxPoint nextPt; for( int step=1; step<=STEPS; ++step ) { double rotation = ( angle * step )/STEPS; nextPt = start; RotatePoint( &nextPt.x, &nextPt.y, center.x, center.y, rotation ); path->AppendPoint( mapPt( nextPt ) ); } prevPt = nextPt; } break; case S_CIRCLE: #if 0 // do not output a circle, freerouter does not understand it. // this might be a mounting hole or something, ignore it without error // because some of our demo boards have used the edges pcb layer to // hold islanded circles, rather than simply using holes. break; #else // Do not output a circle, freerouter does not understand it. // tell user his board has a problem, this is better than silently // ignoring the error. "edges pcb" layer should not be used // to hold islanded circles which could or should be better done // as simple holes. (Some of our demo boards have this problem.) // fall thru here to report the error. #endif default: { wxString error; error.Printf( _( "Unsupported DRAWSEGMENT type %s" ), GetChars( BOARD_ITEM::ShowShape( (STROKE_T) graphic->GetShape() ) ) ); ThrowIOError( error ); } break; } if( items.GetCount() == 0 ) break; graphic = findPoint( prevPt, &items ); if( !graphic ) { wxString error; error << _("Unable to find the next segment with an endpoint of "); error << prevPt; error << wxChar('\n'); error << _("Edit Edges_Pcb segments, making them contiguous."); ThrowIOError( error ); } } #if 0 && defined(DEBUG) STRING_FORMATTER sf; path->Format( &sf, 0 ); printf( "%s\n", sf.GetString().c_str() ); #endif } else { EDA_RECT bbbox = aBoard->ComputeBoundingBox(); RECTANGLE* rect = new RECTANGLE( boundary ); boundary->rectangle = rect; rect->layer_id = "pcb"; // opposite corners wxPoint bottomRight( bbbox.GetRight(), bbbox.GetBottom() ); rect->SetCorners( mapPt( bbbox.GetOrigin() ), mapPt( bottomRight ) ); } } typedef std::set STRINGSET; typedef std::pair STRINGSET_PAIR; void SPECCTRA_DB::FromBOARD( BOARD* aBoard ) throw( IO_ERROR ) { TYPE_COLLECTOR items; static const KICAD_T scanMODULEs[] = { PCB_MODULE_T, EOT }; // Not all boards are exportable. Check that all reference Ids are unique. // Unless they are unique, we cannot import the session file which comes // back to us later from the router. { TYPE_COLLECTOR padItems; items.Collect( aBoard, scanMODULEs ); STRINGSET refs; // holds module reference designators for( int i=0; iGetReference() == wxEmptyString ) { ThrowIOError( _( "Component with value of '%s' has empty reference id." ), GetChars( module->GetValue() ) ); } // if we cannot insert OK, that means the reference has been seen before. STRINGSET_PAIR refpair = refs.insert( TO_UTF8( module->GetReference() ) ); if( !refpair.second ) // insert failed { ThrowIOError( _( "Multiple components have identical reference IDs of '%s'." ), GetChars( module->GetReference() ) ); } } } if( !pcb ) pcb = SPECCTRA_DB::MakePCB(); //---------------------------------------------------- { // specctra wants top physical layer first, then going down to the // bottom most physical layer in physical sequence. // @question : why does KiCad not display layers in that order? buildLayerMaps( aBoard ); int layerCount = aBoard->GetCopperLayerCount(); for( LAYER_NUM pcbNdx=FIRST_LAYER; pcbNdxstructure ); pcb->structure->layers.push_back( layer ); layer->name = layerIds[pcbNdx]; DSN_T layerType; switch( aBoard->GetLayerType( pcbLayer2kicad[pcbNdx] ) ) { default: case LT_SIGNAL: layerType = T_signal; break; case LT_POWER: layerType = T_power; break; case LT_MIXED: layerType = T_mixed; break; case LT_JUMPER: layerType = T_jumper; break; } layer->layer_type = layerType; layer->properties.push_back( PROPERTY() ); PROPERTY* property = &layer->properties.back(); property->name = "index"; char temp[32]; sprintf( temp, "%d", pcbNdx ); property->value = temp; } } // a space in a quoted token is NOT a terminator, true establishes this. pcb->parser->space_in_quoted_tokens = true; //----- & -------------------- { #if defined(USE_PCBNEW_NANOMETRES) // tell freerouter to use "tenths of micrometers", // which is 100 nm resolution. Possibly more resolution is possible // in freerouter, but it would need testing. pcb->unit->units = T_um; pcb->resolution->units = T_um; pcb->resolution->value = 10; // tenths of a um // pcb->resolution->value = 1000; // "thousandths of a um" (i.e. "nm") #else pcb->unit->units = T_mil; pcb->resolution->units = T_mil; // Kicad only supports 1/10th of mil internal coordinates. So to avoid // having the router give us back 1/100th of mil coordinates which we // will have to round and thereby cause error, we declare our maximum // resolution precisely at 1/10th for now. For more on this, see: // http://www.freerouting.net/usren/viewtopic.php?f=3&t=354 pcb->resolution->value = 10; #endif } //----------------------------------------------- { // Because fillBOUNDARY() can throw an exception, we link in an // empty boundary so the BOUNDARY does not get lost in the event of // of an exception. BOUNDARY* boundary = new BOUNDARY(0); pcb->structure->SetBOUNDARY( boundary ); fillBOUNDARY( aBoard, boundary ); } //------------------------------------------------------------- { char rule[80]; int defaultTrackWidth = aBoard->m_NetClasses.GetDefault()->GetTrackWidth(); int defaultClearance = aBoard->m_NetClasses.GetDefault()->GetClearance(); double clearance = scale( defaultClearance ); STRINGS& rules = pcb->structure->rules->rules; sprintf( rule, "(width %.6g)", scale( defaultTrackWidth ) ); rules.push_back( rule ); sprintf( rule, "(clearance %.6g)", clearance+safetyMargin ); rules.push_back( rule ); // On a high density board (a board with 4 mil tracks, 4 mil spacing) // a typical solder mask clearance will be 2-3 mils. // This exposes 2 to 3 mils of bare board around each pad, and would // leave only 1 to 2 mils of solder mask between the solder mask's boundary // to the edge of any trace within "clearance" of the pad. So we need at least // 2 mils *extra* clearance for traces which would come near a pad on // a different net. So if the baseline trace to trace clearance was say 4 mils, then // the SMD to trace clearance should be at least 6 mils. double default_smd = clearance + safetyMargin; if( default_smd <= 6.0 ) default_smd = 6.0; sprintf( rule, "(clearance %.6g (type default_smd))", default_smd ); rules.push_back( rule ); /* see: http://www.freerouting.net/usren/viewtopic.php?f=5&t=339#p474 sprintf( rule, "(clearance %.6g (type pad_to_turn_gap))", clearance + safetyMargin ); rules.push_back( rule ); sprintf( rule, "(clearance %.6g (type smd_to_turn_gap))", clearance + safetyMargin ); rules.push_back( rule ); sprintf( rule, "(clearance %.6g (type via_via))", clearance + safetyMargin ); rules.push_back( rule ); sprintf( rule, "(clearance %.6g (type via_smd))", clearance + safetyMargin ); rules.push_back( rule ); sprintf( rule, "(clearance %.6g (type via_pin))", clearance + safetyMargin ); rules.push_back( rule ); sprintf( rule, "(clearance %.6g (type pin_pin))", clearance + safetyMargin ); rules.push_back( rule ); sprintf( rule, "(clearance %.6g (type smd_pin))", clearance + safetyMargin ); rules.push_back( rule ); */ // well, the user is going to text edit these in the DSN file anyway, // at least until we have an export dialog. // Pad to pad spacing on a single SMT part can be closer than our // clearance, we don't want freerouter complaining about that, so // output a significantly smaller pad to pad clearance to freerouter. clearance = scale( defaultClearance )/4; sprintf( rule, "(clearance %.6g (type smd_smd))", clearance ); rules.push_back( rule ); } //------------------------------------- // Note: only zones are output here, keepout areas be be created later { int netlessZones = 0; static const KICAD_T scanZONEs[] = { PCB_ZONE_AREA_T, EOT }; items.Collect( aBoard, scanZONEs ); for( int i=0; iGetIsKeepout() ) continue; COPPER_PLANE* plane = new COPPER_PLANE( pcb->structure ); pcb->structure->planes.push_back( plane ); PATH* mainPolygon = new PATH( plane, T_polygon ); plane->SetShape( mainPolygon ); plane->name = TO_UTF8( item->GetNetName() ); if( plane->name.size() == 0 ) { char name[32]; // This is one of those no connection zones, netcode=0, and it has no name. // Create a unique, bogus netname. NET* no_net = new NET( pcb->network ); sprintf( name, "@:no_net_%d", netlessZones++ ); no_net->net_id = name; // add the bogus net name to network->nets. pcb->network->nets.push_back( no_net ); // use the bogus net name in the netless zone. plane->name = no_net->net_id; } mainPolygon->layer_id = layerIds[ kicadLayer2pcb[ item->GetLayer() ] ]; int count = item->Outline()->m_CornersList.size(); int ndx = 0; // used in 2 for() loops below for( ; ndxOutline()->m_CornersList[ndx].x, item->Outline()->m_CornersList[ndx].y ); mainPolygon->AppendPoint( mapPt(point) ); // this was the end of the main polygon if( item->Outline()->m_CornersList[ndx].end_contour ) break; } WINDOW* window = 0; PATH* cutout = 0; // handle the cutouts for( ++ndx; ndxOutline()->m_CornersList[ndx-1].end_contour ) { window = new WINDOW( plane ); plane->AddWindow( window ); cutout = new PATH( window, T_polygon ); window->SetShape( cutout ); cutout->layer_id = layerIds[ kicadLayer2pcb[ item->GetLayer() ] ]; } wxASSERT( window ); wxASSERT( cutout ); wxPoint point(item->Outline()->m_CornersList[ndx].x, item->Outline()->m_CornersList[ndx].y ); cutout->AppendPoint( mapPt(point) ); } } } //------------------------------------- { static const KICAD_T scanZONEs[] = { PCB_ZONE_AREA_T, EOT }; items.Collect( aBoard, scanZONEs ); for( int i=0; iGetIsKeepout() ) continue; // keepout areas have a type. types are // T_place_keepout, T_via_keepout, T_wire_keepout, // T_bend_keepout, T_elongate_keepout, T_keepout. // Pcbnew knows only T_keepout, T_via_keepout and T_wire_keepout DSN_T keepout_type; if( item->GetDoNotAllowVias() && item->GetDoNotAllowTracks() ) keepout_type = T_keepout; else if( item->GetDoNotAllowVias() ) keepout_type = T_via_keepout; else if( item->GetDoNotAllowTracks() ) keepout_type = T_wire_keepout; else keepout_type = T_keepout; KEEPOUT* keepout = new KEEPOUT( pcb->structure, keepout_type ); pcb->structure->keepouts.push_back( keepout ); PATH* mainPolygon = new PATH( keepout, T_polygon ); keepout->SetShape( mainPolygon ); mainPolygon->layer_id = layerIds[ kicadLayer2pcb[ item->GetLayer() ] ]; int count = item->Outline()->m_CornersList.size(); int ndx = 0; // used in 2 for() loops below for( ; ndxOutline()->m_CornersList[ndx].x, item->Outline()->m_CornersList[ndx].y ); mainPolygon->AppendPoint( mapPt(point) ); // this was the end of the main polygon if( item->Outline()->m_CornersList[ndx].end_contour ) break; } WINDOW* window = 0; PATH* cutout = 0; // handle the cutouts for( ++ndx; ndxOutline()->m_CornersList[ndx-1].end_contour ) { window = new WINDOW( keepout ); keepout->AddWindow( window ); cutout = new PATH( window, T_polygon ); window->SetShape( cutout ); cutout->layer_id = layerIds[ kicadLayer2pcb[ item->GetLayer() ] ]; } wxASSERT( window ); wxASSERT( cutout ); wxPoint point(item->Outline()->m_CornersList[ndx].x, item->Outline()->m_CornersList[ndx].y ); cutout->AppendPoint( mapPt(point) ); } } } //---------------------------- { PIN_REF empty( pcb->network ); std::string componentId; // find the highest numbered netCode within the board. int highestNetCode = aBoard->GetNetCount() - 1; deleteNETs(); // expand the net vector to highestNetCode+1, setting empty to NULL nets.resize( highestNetCode+1, NULL ); // skip netcode = 0 for( unsigned i=1; inetwork ); for( unsigned ii = 0; ii < aBoard->GetNetCount(); ii++ ) { NETINFO_ITEM* net = aBoard->FindNet(ii); int netcode = net->GetNet(); if( netcode > 0 ) nets[ netcode ]->net_id = TO_UTF8( net->GetNetname() ); } items.Collect( aBoard, scanMODULEs ); padstackset.clear(); for( int m=0; mGetReference() ); // create a net list entry for all the actual pins in the image // for the current module. location of this code is critical // because we fabricated some pin names to ensure unique-ness // of pin names within a module, do not move this code because // the life of this 'IMAGE* image' is not necessarily long. The // exported netlist will have some fabricated pin names in it. // If you don't like fabricated pin names, then make sure all pads // within your MODULEs are uniquely named! for( unsigned p=0; ppins.size(); ++p ) { PIN* pin = &image->pins[p]; int netcode = pin->kiNetCode; if( netcode > 0 ) { NET* net = nets[netcode]; net->pins.push_back( empty ); PIN_REF& pin_ref = net->pins.back(); pin_ref.component_id = componentId; pin_ref.pin_id = pin->pin_id; } } IMAGE* registered = pcb->library->LookupIMAGE( image ); if( registered != image ) { // If our new 'image' is not a unique IMAGE, delete it. // and use the registered one, known as 'image' after this. delete image; image = registered; } COMPONENT* comp = pcb->placement->LookupCOMPONENT( image->GetImageId() ); PLACE* place = new PLACE( comp ); comp->places.push_back( place ); place->SetRotation( module->GetOrientation()/10.0 ); place->SetVertex( mapPt( module->GetPosition() ) ); place->component_id = componentId; place->part_number = TO_UTF8( module->GetValue() ); // module is flipped from bottom side, set side to T_back if( module->GetFlag() ) { int angle = 1800 - module->GetOrientation(); NORMALIZE_ANGLE_POS(angle); place->SetRotation( angle/10.0 ); place->side = T_back; } } // copy the SPECCTRA_DB::padstackset to the LIBRARY. Since we are // removing, do not increment the iterator for( PADSTACKSET::iterator i=padstackset.begin(); i!=padstackset.end(); i=padstackset.begin() ) { PADSTACKSET::auto_type ps = padstackset.release( i ); PADSTACK* padstack = ps.release(); pcb->library->AddPadstack( padstack ); } // copy our SPECCTRA_DB::nets to the pcb->network for( unsigned n=1; npins.size() ) { // give ownership to pcb->network pcb->network->nets.push_back( net ); nets[n] = 0; } } } //-----< output vias used in netclasses and as stock >--------------------- { NETCLASSES& nclasses = aBoard->m_NetClasses; // Add the via from the Default netclass first. The via container // in pcb->library preserves the sequence of addition. NETCLASS* netclass = nclasses.GetDefault(); PADSTACK* via = makeVia( netclass->GetViaDiameter(), netclass->GetViaDrill(), FIRST_LAYER, aBoard->GetCopperLayerCount()-1 ); // we AppendVia() this first one, there is no way it can be a duplicate, // the pcb->library via container is empty at this point. After this, // we'll have to use LookupVia(). wxASSERT( pcb->library->vias.size() == 0 ); pcb->library->AppendVia( via ); // output the stock vias, but preserve uniqueness in the via container by // using LookupVia(). for( unsigned i=0; i < aBoard->m_ViasDimensionsList.size(); ++i ) { int viaSize = aBoard->m_ViasDimensionsList[i].m_Diameter; int viaDrill = aBoard->m_ViasDimensionsList[i].m_Drill; via = makeVia( viaSize, viaDrill, FIRST_LAYER, aBoard->GetCopperLayerCount()-1 ); // maybe add 'via' to the library, but only if unique. PADSTACK* registered = pcb->library->LookupVia( via ); if( registered != via ) delete via; } // set the "spare via" index at the start of the // pcb->library->spareViaIndex = pcb->library->vias.size(); // output the non-Default netclass vias for( NETCLASSES::iterator nc = nclasses.begin(); nc != nclasses.end(); ++nc ) { netclass = nc->second; via = makeVia( netclass->GetViaDiameter(), netclass->GetViaDrill(), FIRST_LAYER, aBoard->GetCopperLayerCount()-1 ); // maybe add 'via' to the library, but only if unique. PADSTACK* registered = pcb->library->LookupVia( via ); if( registered != via ) delete via; } } #if 1 // do existing wires and vias //---------------------------------------- { // export all of them for now, later we'll decide what controls we need // on this. static const KICAD_T scanTRACKs[] = { PCB_TRACE_T, EOT }; items.Collect( aBoard, scanTRACKs ); std::string netname; WIRING* wiring = pcb->wiring; PATH* path = 0; int old_netcode = -1; int old_width = -1; LAYER_NUM old_layer = UNDEFINED_LAYER; for( int i=0; iGetNet(); if( netcode == 0 ) continue; if( old_netcode != netcode || old_width != track->GetWidth() || old_layer != track->GetLayer() || (path && path->points.back() != mapPt(track->GetStart()) ) ) { old_width = track->GetWidth(); old_layer = track->GetLayer(); if( old_netcode != netcode ) { old_netcode = netcode; NETINFO_ITEM* net = aBoard->FindNet( netcode ); wxASSERT( net ); netname = TO_UTF8( net->GetNetname() ); } WIRE* wire = new WIRE( wiring ); wiring->wires.push_back( wire ); wire->net_id = netname; wire->wire_type = T_protect; // @todo, this should be configurable LAYER_NUM kiLayer = track->GetLayer(); LAYER_NUM pcbLayer = kicadLayer2pcb[kiLayer]; path = new PATH( wire ); wire->SetShape( path ); path->layer_id = layerIds[pcbLayer]; path->aperture_width = scale( old_width ); path->AppendPoint( mapPt( track->GetStart() ) ); } path->AppendPoint( mapPt( track->GetEnd() ) ); } } //---------------------- { // export all of them for now, later we'll decide what controls we need // on this. static const KICAD_T scanVIAs[] = { PCB_VIA_T, EOT }; items.Collect( aBoard, scanVIAs ); for( int i=0; iType() == PCB_VIA_T ); int netcode = via->GetNet(); if( netcode == 0 ) continue; PADSTACK* padstack = makeVia( via ); PADSTACK* registered = pcb->library->LookupVia( padstack ); // if the one looked up is not our padstack, then delete our padstack // since it was a duplicate of one already registered. if( padstack != registered ) { delete padstack; } WIRE_VIA* dsnVia = new WIRE_VIA( pcb->wiring ); pcb->wiring->wire_vias.push_back( dsnVia ); dsnVia->padstack_id = registered->padstack_id; dsnVia->vertexes.push_back( mapPt( via->GetPosition() ) ); NETINFO_ITEM* net = aBoard->FindNet( netcode ); wxASSERT( net ); dsnVia->net_id = TO_UTF8( net->GetNetname() ); dsnVia->via_type = T_protect; // @todo, this should be configurable } } #endif // do existing wires and vias //------------------------------------------------------ { // The pcb->library will output which is a combined // list of part padstacks and via padstacks. specctra dsn uses the // to say which of those padstacks are vias. // Output the vias in the padstack list here, by name only. This must // be done after exporting existing vias as WIRE_VIAs. VIA* vias = pcb->structure->via; for( unsigned viaNdx=0; viaNdx < pcb->library->vias.size(); ++viaNdx ) { vias->AppendVia( pcb->library->vias[viaNdx].padstack_id.c_str() ); } } //--------------------------------------------------------- NETCLASSES& nclasses = aBoard->m_NetClasses; exportNETCLASS( nclasses.GetDefault(), aBoard ); for( NETCLASSES::iterator nc = nclasses.begin(); nc != nclasses.end(); ++nc ) { NETCLASS* netclass = nc->second; exportNETCLASS( netclass, aBoard ); } } void SPECCTRA_DB::exportNETCLASS( NETCLASS* aNetClass, BOARD* aBoard ) { /* From page 11 of specctra spec: Routing and Placement Rule Hierarchies Routing and placement rules can be defined at multiple levels of design specification. When a routing or placement rule is defined for an object at multiple levels, a predefined routing or placement precedence order automatically determines which rule to apply to the object. The routing rule precedence order is pcb < layer < class < class layer < group_set < group_set layer < net < net layer < group < group layer < fromto < fromto layer < class_class < class_class layer < padstack < region < class region < net region < class_class region A pcb rule (global rule for the PCB design) has the lowest precedence in the hierarchy. A class-to-class region rule has the highest precedence. Rules set at one level of the hierarchy override conflicting rules set at lower levels. The placement rule precedence order is pcb < image_set < image < component < super cluster < room < room_image_set < family_family < image_image A pcb rule (global rule for the PCB design) has the lowest precedence in the hierarchy. An image-to-image rule has the highest precedence. Rules set at one level of the hierarchy override conflicting rules set at lower levels. */ char text[256]; CLASS* clazz = new CLASS( pcb->network ); pcb->network->classes.push_back( clazz ); // freerouter creates a class named 'default' anyway, and if we // try and use that, we end up with two 'default' via rules so use // something else as the name of our default class. clazz->class_id = TO_UTF8( aNetClass->GetName() ); for( NETCLASS::iterator net = aNetClass->begin(); net != aNetClass->end(); ++net ) clazz->net_ids.push_back( TO_UTF8( *net ) ); clazz->rules = new RULE( clazz, T_rule ); // output the track width. int trackWidth = aNetClass->GetTrackWidth(); sprintf( text, "(width %.6g)", scale( trackWidth ) ); clazz->rules->rules.push_back( text ); // output the clearance. int clearance = aNetClass->GetClearance(); sprintf( text, "(clearance %.6g)", scale( clearance ) + safetyMargin ); clazz->rules->rules.push_back( text ); if( aNetClass->GetName() == NETCLASS::Default ) { clazz->class_id = "kicad_default"; } // the easiest way to get the via name is to create a via (which generates // the name internal to the PADSTACK), and then grab the name and then // delete the via. There are not that many netclasses so // this should never become a performance issue. PADSTACK* via = makeVia( aNetClass->GetViaDiameter(), aNetClass->GetViaDrill(), FIRST_LAYER, aBoard->GetCopperLayerCount()-1 ); snprintf( text, sizeof(text), "(use_via %s)", via->GetPadstackId().c_str() ); clazz->circuit.push_back( text ); delete via; } void SPECCTRA_DB::FlipMODULEs( BOARD* aBoard ) { for( MODULE* module = aBoard->m_Modules; module; module = module->Next() ) { module->SetFlag( 0 ); if( module->GetLayer() == LAYER_N_BACK ) { module->Flip( module->GetPosition() ); module->SetFlag( 1 ); } } modulesAreFlipped = true; } void SPECCTRA_DB::RevertMODULEs( BOARD* aBoard ) { if( !modulesAreFlipped ) return; // DSN Images (=KiCad MODULES and pads) must be presented from the // top view. Restore those that were flipped. for( MODULE* module = aBoard->m_Modules; module; module = module->Next() ) { if( module->GetFlag() ) { module->Flip( module->GetPosition() ); module->SetFlag( 0 ); } } modulesAreFlipped = false; } } // namespace DSN