xPDK_BB
  Structure
  Details

---

generateDRC=.. generateDerived=.. generateLVS=.. portMapDC=.. portMapDCi=.. portMapDCo=.. portMapIn=.. portMapOut=.. portMapRF=.. portMapRFi=.. portMapRFo=.. xPDK_Header:pdk_name=..
  <bb> ...  -tp->
  <bbAnnotateFontSize> ...  -tp->
  <bbAnnotateName> ...  -tp->
  <bbLaser> ...  -tp->
  <bbModulator> ...  -tp->
  <bbPIN> ...  -tp->
  <bbPassive> ...  -tp->
  <bbSOA> ...  -tp->
  <bbTransition> ...  -tp->
  <bbWaveguide> ...  -tp->
  <changelog> ...  -tp->
  <run_name> ...  -tp->
  <ticket> ...  -tp->
  <xPDK_CompactModel_List> ...  -tp->
  <xPDK_Layout> ...  -tp->
  <xsection> ...  -tp->
  <xPDK_Header:attribute> ...  -tp->
  <xPDK_Header:doc> ...  -tp->
  <xPDK_Header:global> ...  -tp->
  <xPDK_Header:license> ...  -tp->
  <xPDK_Header:mpw_run> ...  -tp->
  <xPDK_Header:provider> ...  -tp->
  <xPDK_Header:tex> ...  -tp->
  <xPDK_Header:version> ...  -tp->

xPDK_BB

This section in a xPDK extends from xPDK_Header.

This BB information contains the typical shared data between software:

• building blocks
• their parameters
• connections
• user interface behavior
• simple layout information
• references to compact model information

This information is needed in schematic design and circuit simulation as well as in layout.

This scope is therefore fairly broad and future extensions are likely to capture more information. The current common fields provide for a rich design kit already compared to other formats, while adressing different software.
Vendor extensions are supported in this section, so software specific details are possible therefore to tune behavior.

Extensive example

This example is part of the full file below. It is mostly listed here so you do not need to download it. It shows many fields and properties that can be defined and these are described in the child pages.
This file includes the technology file and adds the Met, Met1 and Met2 xsection's in the meta data to show both options work.

Use:

xmllint - -format - -xinclude - -schema xPDK_BB.xsd xPDK_BB.xml

to validate.

Structure

The attributes and elements are shown below, in a sorted per type fashion.
In case a list is printed after an element, it indicates that you can have many, otherwise it should be a single element. With a optional it tells the element is not required.

---

<xPDK_BB  generateDRC="..."  generateDerived="..."  generateLVS="..."  portMapDC="..."  portMapDCi="..."  portMapDCo="..."  portMapIn="..."  portMapOut="..."  portMapRF="..."  portMapRFi="..."  portMapRFo="..."  xPDK_Header:pdk_name="..." ... > ...
  <bb> ... </bb>   list
  <bbAnnotateFontSize> ... </bbAnnotateFontSize>    optional
  <bbAnnotateName> ... </bbAnnotateName>    optional
  <bbLaser> ... </bbLaser>   list
  <bbModulator> ... </bbModulator>   list
  <bbPIN> ... </bbPIN>   list
  <bbPassive> ... </bbPassive>   list
  <bbSOA> ... </bbSOA>   list
  <bbTransition> ... </bbTransition>   list
  <bbWaveguide> ... </bbWaveguide>   list
  <changelog> ... </changelog>   list
  <run_name> ... </run_name>   list
  <ticket> ... </ticket>   list
  <xPDK_CompactModel_List> ... </xPDK_CompactModel_List>   list
  <xPDK_Layout> ... </xPDK_Layout>   list
  <xsection> ... </xsection>   list
  <xPDK_Header:attribute> ... </attribute>   list
  <xPDK_Header:doc> ... </doc>    optional
  <xPDK_Header:global> ... </global>   list
  <xPDK_Header:license> ... </license>    optional
  <xPDK_Header:mpw_run> ... </mpw_run>   list
  <xPDK_Header:provider> ... </provider>    optional
  <xPDK_Header:tex> ... </tex>    optional
  <xPDK_Header:version> ... </version>    optional
</xPDK_BB>

---

XSD

The schema file can be downloaded or viewed at xPDK_BB.

Details

Type xPDK_Header

Header with some typical information for most xPDK files.

Most is optional and extension capability is the idea.

bb

Define a series of building blocks, sometimes called cell or pcell also (EDA terminology).
This section is used by both layout and schematic / circuit oriented software to allow designers to create their circuits. In general it does not make sense to have design kits without BBs in there. However it is not a required to have them - there are gds layer / process only design kits also.
Type pdaBBdefinition documentation: BB definitions including ports, parameters, attributes and views.

Basic fields

The following example shows the basic information that is expected (but not required). With this content you can start using it in different software. It does not define parameters, so it is a fixed design.
Normally BB's have more ports as well as parameters, so a "real" BB will be longer.

Documentation

Adding documentation is easy also, the doc is used by more software then the tex. tex is for long pieces of text like full help pages.

Alignment

A building block can be validated on angle - this is using the "org" port as coordinate reference.
You can select one of the following options: Manhattan, Xaligned, Yaligned, Angles as a series of values
Note that the global position of this is relevant; if you use the BB in your library and thus create a design hierarchy, the (relative) location inside the library netlist/component is not relevant.

Check definition

The xPDK format allows many aspects to be defined. To check that you defined it correctly, you can use the xsl files that convert the definition to the software of your choice.
A basic option is to use the gdspy project. The xsl/xPDK_toPython.xsl can use this library to generate the basic curves / black box designs. You can convert the BB.xml (as that includes the Layout.xml) in a simple script to generate a pdk.py.

xmllint --xinclude BB.xml | xmlstarlet tr $XPDK/xsl/xPDK_toPython.xsl -s pdkiteration=0 -s whitebox='nocell' > export/pdk.py

This (large) python file uses the xPDK Geometry.py and gdspy code jointly to allow the different boundary views, port locations and so on to be written to a GDS file or shown on screen.
Suppose you want to test the definition of a BB called myBB that has a paramter Length. Create a test.py with the following content:

from Geometry import Design
from pdk import *

myDesign=Design('/tmp/myBB.gds')
t=myBB()
t.Length=10
e0=t.place(myDesign,"element0",org=[0])
#e0.print_boundary()
t.Length=20
e1=t.place(dp,bir=e0.bol)
#e1.print_boundary()
#myDesign.draw_gdspy() # Just generate GDS
myDesign.draw_gdspy(show=True) # Show on screen
myDesign.write()

This should place two myBB's on the design, one with Length=10 and one with Length=20. The GDS file will depend on the type of BB (whitebox or not) and the -s whitebox='nocell' command line option. For black-box and grey-box BBs you should see two GDS cells, one per parameter setting.

bbAnnotateFontSize

Type bbAnnotateFontSize documentation:

bbAnnotateName

Type bbAnnotateName documentation:

bbLaser

Type bbLaser documentation: Laser.
This group defines the BBs that convert electrical power to optical signal, normally with II/VI or III/V materials. Typically they contain an bbSOA. The main difference is that some reflection mechanism is used on both sides which changes behavior a lot. Therefore the lasers are normally defined with a single optical output.

bbModulator

Type bbModulator documentation: Electro/thermo optical component (or other domain that modifies optical properties like chemical sensors or mechanical switches).
This group defines the BBs that have some non-optical influence that impacts the optical performance of the underlying m * n port component. Typical BBs are electro optic and thermo optic modulators which add to the 2 optical ports the 2 electrical ports. For the amount of electrical ports the speed is sometimes relevant too - for high speed (RF) often balanced or g/s/g ports are configured.

bbPIN

Type bbPIN documentation: Detector.
This group defines the BBs that provide optical to electrical conversion. This can be full power capture (so 1 optical in) or more like a power monitor that leaves most of the power going through (so 1 optical in, 1 out).
For electrical signal the amount of ports depends normally on "DC" or "RF" style speeds.

bbPassive

Type bbPassive documentation: This group is for passive component - until we have a better name.
This includes couplers, splitters, mode filters and so on. So any m * n port BB that has no driving / steering conditions (apart from maybe some thermal tuning for stability).

bbSOA

Type bbSOA documentation: Optical gain block.
This group defines the BBs that provide optical gain, normally by driving it electrical in II/VI or III/V materials. They tend to have 2 optical ports (in / out) and one or more electrical driving ports, depending on the substrate style - if the substrate is ground, then 1 electrical driving port can be enough allthough in practice multiple "electrical source ports" are sometimes used also to give better gain uniformity.

bbTransition

Type bbTransition documentation: This group is for waveguide transitions.
Transitions are often fixed components - no parameters. They have the optical input in 1 xsection and the optical output in another one.

bbWaveguide

Type bbWaveguide documentation: This group is for waveguides.
The waveguides can be any routing shape, so we consider the straight waveguides as well as the arc, sine, cosine and euler bends all to be waveguides. But also things like "inbetween" connectors. A combination of waveguide segments like an arc/line/arc could be defined as waveguide.
Waveguides have an optical in and out. Sometimes they are thermally tuned, so having more ports is fine.

changelog

Type xPDK_ChangeLog documentation: Trace changes to the data.
This is time-stamped change list, which can be empty. Software or design kit providers are not required to fill this data when changes are made, but it can help users to see what changed over time.

extend

Type AllowExtend documentation: This section allows to add your own field or attributes.

Allows to extend with any (complex) data for enriching a design kit. The sub-data of an extend will normally be vendor or provider specific, but may span multiple software vendors or suppliers.

Provider extensions can be references to (or embedded) reporting scripts or their versions; source database references and so on. Such data is helpful in cross-referencing production issues or differences between export snapshots. Embedding such data in the XML rather then side-files enhances tracebility and reduces errors.

Using this section is not considered part of the xPDK format therefore, but as long as the files validate with the Stichting PDAFlow Foundation schema's, it is not considered a (not allowed) Derivative version.
For conventions, please check also Extensions.
See also xPDK License.

generateDRC

Type generateDRC documentation: Specify that the DRC layer operations in the tech-file should be converted to ICValidator deck.

generateDerived

Type generateDerived documentation: Specify that the derived layer operations in the tech-file should be converted to ICValidator deck.

generateLVS

Type generateLVS documentation: Specify that an LVS deck should be generated for ICValidator.

portMapDC

Type portMapDC documentation: Use the port label or label_rev to pick the direction; do not add numbers.

portMapDCi

Type portMapDCi documentation: Use the port label or label_rev to pick the direction; do not add numbers.

portMapDCo

Type portMapDCo documentation: Use the port label or label_rev to pick the direction; do not add numbers.

portMapIn

Type portMapIn documentation: Use the port label or label_rev to pick the direction; do not add numbers.

portMapOut

Type portMapOut documentation: Use the port label or label_rev to pick the direction; do not add numbers.

portMapRF

Type portMapRF documentation: Use the port label or label_rev to pick the direction; do not add numbers.

portMapRFi

Type portMapRFi documentation: Use the port label or label_rev to pick the direction; do not add numbers.

portMapRFo

Type portMapRFo documentation: Use the port label or label_rev to pick the direction; do not add numbers.

run_name

Define the wafer runs (fab shuttles) names for which this PDK can be used. Type pdaIdentifier documentation: Defines a valid name for an identifier.

Identifiers are used in the Python library for the getName() and setName() function and can thus be used to identify the different elements in lists.
In text the specification is a letter, followed by letters, numbers, underscore or dot. The XSD schema validation is a regular expression: [A-Za-z]([A-Za-z0-9_])*

ticket

Type pdaTicket documentation: Specify something to look at / fix.

xPDK_CompactModel_List

Include the defined compact models for easy checks and/or define them locally.
Using the <xi:include ... /> is the preferred route as it allows to share the definition between design kits.
See building block type for the more details on what this section defines. The preferred route is to include such files rather then embedding them.
Type xPDK_CompactModel_List documentation: This section in a xPDK extends from xPDK_Header.

The Compact Model List file provides a table with building block types. Per building block type a list of models is defined that describes what type of (compact) model should be defined for a BB/Model definition file using the Circuit Simulation file.

xPDK_Layout

Include the technology file and/or define them locally.
Include a full technology file to avoid copy/paste errors and other data inconsistencies. See xPDK_Layout.xml for how to do this.

Define basic technology info.

The technology file contains the xsection information which is needed in the port to make sure the references are correct. To get this information, you can include a full technology file or just query the data using xsltproc and keep the (xs:include expanded) meta data file short.

Technology file → summary

You can run the following to summarize a technology file for the (embedded or xs:include'd) xsection list.

xsltproc - -xinclude xPDK_xsection_list.xsl xPDK_Layout.xml

This should give the following output: The XSLT file can be downloaded: xPDK_xsection_list.xsl.
Type xPDK_Layout documentation: This section in a xPDK extends from xPDK_Header.

The layout section contains information for mask layout purposes as well as performing derived layer operations and (geometrical) design rule checking. It is therefore the key information for getting correct GDS files to a foundry.

Layer operations

The definition order in the XML file does not define the order of the operations to go from a schematic design (circuit or layout style) to the final GDS polygons, cells and other data in the GDS file. This would complicate the definition; instead the order of operations is defined by the following steps. The software writing the GDS is responsible for the correct order.

• Xsection grid
  The grid mappings define how the waveguide shapes are widening or mapped to different layer and applayer polygon / ... shapes. The widening operation is defined somehwat simple as creating a comparable shape with a wider width; it is therefore not the same as a layerSize or layerGrow operation.
  In case the xsection is defined implicitly via the autoXsection=true, the 1:1 mapping to the gdslayer is expected. After this steps shapes should be considered as polygons, even if the software uses more advanced shapes internally.
• Derived layers
  For each layer the software should ensure that all layers that it derives from are fully known. So if layer A depends on layers B and C & C depends on B, first B should be calculated, then C and A as last. The software is responsible for resolving this correct order.
  Each layer can be the target of multiple layer output operations in addition to being the output of the xsection/grid mappings. The output of all layer operations should jointly be used ("layer or/joined") as the final output.
• Geometric design rule checks
  The design rule checks should operate on the final output per layer; this can be done as soon as a layer is ready or later. In case of multi-layer design rule checks, the software is responsible that all layers in such a check are final; the order of design rule definitions in the XML file related to (derived) layer operations is not relevant.

Derived layer operations

Derived layer operations are common in chip design to simplify work for designers and make their work more efficient and less error-prone. This holds for both single-layer and multi-layer operations.

The implementations of these operations vary strongly per software so efficiency (cpu, runtime, memory) will be different per software. In general a tool-specific set of operations can be much (> 10x) faster then a generic / converted deck and (optimal) runtime may easily be hours of wallclock-time, see also Design Rule Checking.

Multi-layer derived layers look like the single-layer operations, they mainly differ in the amount of layers that are used.
For the input of the operations there are two flavors - the named layers A, B and sometimes C. And the layer list via a list of layer fields. The first option is used if order of layers is relevant, for example in a layerAnotB. Changing the A & B layers will lead to very different results.

The layer-list is suitable in case many layers can be used and ordering is not important. This option like in layerIsCoveredBy do use a list of layers like in the Cover and In fields, which combine like an "or".

The output of the operation is (for derived layers) stored in the layer in which the operation was defined, this can be a gds layer or an applayer.

Derived layers (single & multiple) are often needed to be able do define DRC rules more precisely as they tend to have clauses like "if this & that, then the rule is so&so". This this&that and so&so are both often derived layers.

Some "single layer derived" layers are shown here.
Here the layerGrow, layerSize and layerShrink fill up content in this layer from another one. The A-reference should be to a GDS layer.

Design rule checking

This section describes the geometric (layer) design rule checking options that operate on geometric data. Often you need to assemble a chain of derived layer operations to get the required rule check.
A simple example is a minimum width check - you can implement this by a "shrink, followed by a grow" and then do a layer overlap with the original to see if there is a difference (note: this is not a fast way and not recommended!).

The operation chain is often using intermediate layers that are not needed in the output files - hence the use of applayer to store such interim layers. Sometimes the operations are just needed on the input data - so it can be a puzzle to write a test down in geometric correct specifications.
A second complication is that different software implements the tests and boolean operations differently; so an optimal result (in cpu / runtime / memory) on one software may not be so on another one. It is therefore recommended to validate with software vendors to see that the layer-operation chain and design rule check is well defined.
In general the best option is to use as few layer operations as possible with as little layers as possible in the rule check, but there are clear and common exceptions to this.

To validate the rule is correctly implemented, it is recommended to make a test design per rule; such a design should contain one or more of the failing designs, a few just-passing designs and some designs with a clear pass. The amount of pass/fail tests depends on the complexity of the rule.
With OptoDesigner you can then validate the operations to get the correct amount of fails. Setting up the regressionstesting with autoxml then allows you to automate the testing during new releases, so you reduce much effort in maintenance on existing rules, while not risking operations in the layer-operation chain failing due to extending the DRC deck.

The (clock) runtime of larger DRC decks can be considerable, even for photonics designs which are mostly empty space on the chip compared to electronic designs. The difference between a well-written / tool-specific DRC deck and a xPDK_Layout converted version is likely to be very relevant to designers. First of all because the tool-specific deck can use more / faster operations then xPDK_Layout supports. And secondary because the optimal layer operation chain + rule validation is different per tool.
You may need to make the choice therefore between cost for designers versus cost for the foundry (DRC deck user versus provider).

In short - be careful with the layer operations to make sure your DRC deck runs fast enough. And talk with your software partners to implement rules.

A simple exapmle is shown here. That extends these a bit with more layer references and some more values.

OptoDesigner export

The xPDK_toOptoDesigner02.xsl used the information to convert a xPDK Layout file into a 02-file as part of the OptoDesigner design kit or a self contained example that can be used directly.
In the former case you should also convert a xPDK BB file into a 04-file and your layout-only design kit is ready (the xsl is not yet there).
For the latter case it provides an easy way to embed BB, DRC, ... test files and user examples inside the technology file so if the die-template, design rules, ... change you can easily re-generate an extensive set of test cases and user examples.

xsection

Define local xsection's which can be added to a technology file or be just the a sub-set of the technology file to reduce file size and make the files stand-alone.

You can copy the output of the summary generation into the XML file and/or define additional xsection. As only the name is needed, the list is short.

Sometimes it is handy to add xsection's for port's that are not defined in the basic technology file. Such a list can include parts of the technology file instead of the full include.
Note - adding xsection's here that include GDS layer mapportgs is ok for the XML, but you risk that the software that only uses the technology file does not use all data.

Type pdaXsection documentation: Define xsection/mcs/cad/design layers with optical related properties.

Design layers which map via gridding onto GDS/Oasis/OpenAccess layers. xsection's provide for "optical" logic like default width, bend radius, coupling length and so on.
Each design layer can map to multipe GDS layers, so you can define a layer stack relating to a waveguide in a single definition.
Take for example a typical core, cladding and trench or some under/over etch compensation. This approach is not only suitable for photonics, but is practical in many technologies. The picture below shows a cross-section of a (printed) transistor.



Instead of writing in many GDS layers, you can simply use the xsection which represents OptoDesigner's mcs concept which is shown in the picture.

xsection

This defines a xsection which in EDA-design is often called a cad or design layer. In OptoDesigner this is a mcs. The xsection's define what the port should refer to. A xsection is normally something like a waveguide or metal track and is often using multiple (gds) layers.

Very basic definition.

This definition is good for marking things up, but elements placed in this design layer will not go to a mask file.

Including GDS mapping and some properties

attribute

Type pdaAttributeType documentation: Attributes are key/value pairs to annotate building blocks and views with information that is likely to be software specific. So it is more a 'flag' then a value. The value is just a string and not something with an expression in it.

doc

Type pdaDocumentation documentation: Document anything relevant for the topic you want to define.

This field allows some (short, few lines) documentation to be written. It can be a long string, but the idea is not to replace a design manual.
This fields is like tex which allows documentation in LaTex format; doc is restricted to plain text.

global

Type pdaNamedValue documentation: Create a named value with expression / type support.

license

Define the license condition for this file. Type pdaLicense documentation: Define license information.

State the basic conditions of using the file and typically refer to legal documents.
License information should be compact enough to be clear as reference. The reference is expected to be to signed documents like Non Disclose Agreements (NDA) or service contracts and so on.

mpw_run

Define a list of tape-outs for which a design kit or other data file can be applied. Type pdaMPWrun documentation: Multi-Project Wafer (MPW) run that will support the given PDK library.

pdk_name

Library / process name; a foundry can supply many PDKs under the same provider name.

The pdk_name at the start (just below the xsi:noNamespaceSchemaLocation defines the design kit name and is intended as a relatively short name. It should be unique enough to avoid confusion by designers. Type pdaPDKname documentation: Defines a valid name for a PDK - this is slightly more general then the pdaIdentifier.
In text this is a letter or number, followed by letters, numbers, underscore or dot or dash or dollar. The check is regular expression: [A-Za-z0-9]([A-Za-z0-9_#$])*

provider

Define the provider of this document.
Type pdaProvider documentation: This field can be used for a full name of the design kit provider, so a full company or institute name for example, instead of the smaller pdk_name.

tex

Type pdaTexDocumentation documentation: As doc, but tex can be a long text in LaTex format to document the layer in more detail if needed.

You can document anything relevant for the topic you want to define.

Multiple paragraphs is fine. Format is Latex, so more complex content is possible.

version

Define the version of the design kit / data.
Using version numbers helps to keep track of which files to use. Type pdaVersion documentation: