Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

mgRegUserProc

mgRegUserProc(
s_userFunction
)
=> t / nil

Description

Accepts user functions based on their keywords and registers them in the Modgen code to enable callbacks.

Arguments

s_userFunction

Represents a user function symbol. Valid user functions are:

  • 'mgAbutGetEnvProc: Returns the current state of user-defined abutment types.
  • 'mgAbutSetEnvProc: Sets the current state of user-defined abutment types.
  • 'mgUserShapeProc: Registers as user shape callbacks.
  • 'mgPrePlacementProc: Is called before placement in the Modgen.
  • 'mgPlacementCheckProc: Is called after placement to either modify the constraint and rerun the placement or accept the placement and proceed with routing.
  • 'mgGetIdenticalGRDefsProc: Returns the guard ring definition, unit cell parameters, and all associated callbacks.
  • 'mgRouterUserShapeProc: Creates user-defined shapes inside the Modgen after routing.
  • 'mgSurroundDefaultsProc: Sets the default size of devices that surround adjoining Modgen instances when creating identical guard rings.

Value Returned

t

The specified functions were registered.

nil

The functions could not be registered.

Examples

Registers user functions in the Modgen code.

mgRegUserProc(?mgAbutGetEnvProc 'pdkGetAbutFuncName)
mgRegUserProc(?mgAbutSetEnvProc 'pdkSetAbutFuncName)
mgRegUserProc(?mgUserShapeProc 'pdkUserShapeFuncName)
mgRegUserProc(?mgPrePlacementProc 'pdkPrePlaceFuncName)

Return to top
 ⠀
X