Struct substrate::context::PdkContext

pub struct PdkContext<PDK: Pdk + ?Sized> {
    pub pdk: Arc<PDK>,
    pub layers: Arc<PDK::Layers>,
    /* private fields */
}

A Context with an associated PDK PDK.

Fields

pdk: Arc<PDK>

PDK configuration and general data.

layers: Arc<PDK::Layers>

The PDK layer set.

Implementations

impl<PDK: Pdk> PdkContext<PDK>

pub fn new(pdk: PDK) -> Self

Creates a new global context.

pub fn generate_layout<T: Layout<PDK>>(&self, block: T) -> LayoutCellHandle<T>

Generates a layout for block in the background.

Returns a handle to the cell being generated.

pub fn write_layout<T: Layout<PDK>>( &self, block: T, path: impl AsRef<Path> ) -> Result<()>

Writes a layout to a GDS file.

pub fn write_layout_all( &self, cells: impl IntoIterator<Item = Arc<RawCell>>, path: impl AsRef<Path> ) -> Result<()>

Writes a set of layout cells to a GDS file.

pub fn read_gds(&self, path: impl AsRef<Path>) -> Result<ImportedGds>

Reads a layout from a GDS file.

pub fn read_gds_cell( &self, path: impl AsRef<Path>, cell: impl Into<ArcStr> ) -> Result<Arc<RawCell>>

Reads the layout of a single cell from a GDS file.

pub fn install_layers<L: Layers>(&self) -> Arc<L>

Installs a new layer set in the context.

Allows for accessing GDS layers or other extra layers that are not present in the PDK.

pub fn get_gds_layer(&self, spec: GdsLayerSpec) -> Option<LayerId>

Gets a layer by its GDS layer spec.

Should generally not be used except for situations involving GDS import, where layers may be imported at runtime.

Methods from Deref<Target = Context>

pub fn with_pdk<PDK: Pdk>(&self) -> PdkContext<PDK>

Creates a PdkContext for the given installed PDK.

The PDK must first be installed in the context.

pub fn generate_cross_schematic<S1: Schema + ?Sized, S2: FromSchema<S1> + ?Sized, B: Schematic<S1>>( &self, block: B ) -> SchemaCellHandle<S2, B>

Generates a schematic of a block in schema S1 for use in schema S2.

Can only generate a cross schematic with one layer of FromSchema indirection.

pub fn generate_schematic<S: Schema + ?Sized, T: Schematic<S>>( &self, block: T ) -> SchemaCellHandle<S, T>

Generates a schematic for block in the background.

Returns a handle to the cell being generated.

pub fn export_scir<S: Schema + ?Sized, T: Schematic<S>>( &self, block: T ) -> Result<RawLib<S>, ConvError>

Export the given block and all sub-blocks as a SCIR library.

Returns a SCIR library and metadata for converting between SCIR and Substrate formats.

pub fn export_scir_all<S: Schema + ?Sized>( &self, cells: &[&RawCell<S>] ) -> Result<RawLib<S>, ConvError>

Export the given cells and all their subcells as a SCIR library.

Returns a SCIR library and metadata for converting between SCIR and Substrate formats.

pub fn simulate<S, T>( &self, block: T, work_dir: impl Into<PathBuf> ) -> Result<T::Output>

where S: Simulator, T: Testbench<S>,

Simulate the given testbench.

The simulator must be installed in the context.

pub fn get_or_install<I>(&self, installation: I) -> Arc<I>

where I: PrivateInstallation,

Installs the given PrivateInstallation.

Returns the existing installation if one is present.

pub fn get_private_installation<I: PrivateInstallation>(&self) -> Option<Arc<I>>

Gets a private installation from the context installation map.

pub fn get_installation<I: Installation>(&self) -> Option<Arc<I>>

Gets an installation from the context installation map.

Trait Implementations

impl<PDK: Pdk> Clone for PdkContext<PDK>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<PDK: Pdk> Deref for PdkContext<PDK>

type Target = Context

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.