> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atopile.io/llms.txt
> Use this file to discover all available pages before exploring further.

# SWD

## Interfaces

<ParamField path="clk" type="ElectricLogic" />

<ParamField path="dio" type="ElectricLogic" />

<ParamField path="reset" type="ElectricLogic" />

<ParamField path="swo" type="ElectricLogic" />

## Global Attributes

These attributes are available to all modules and interfaces in a design.

<ParamField path="lcsc_id" type="str">
  Assign the LCSC ID of the module.

  If set, this will tell the picker to select that part from LCSC for this block.
</ParamField>

<ParamField path="manufacturer" type="str">
  This module's manufacturer name, as a string.

  Only exact matches on the manufacturer's name will be found by the picker.
  It's recommended to fill this information based on what `ato create component`
  provides.
</ParamField>

<ParamField path="mpn" type="str">
  This module's manufacturer part number, as a string.

  For the picker to select the correct part from the manufacturer,
  this must be set.
</ParamField>

<ParamField path="package" type="str">
  The package of the module.

  This drives which components can be selected, and what footprint is used.

  Must exactly match a known package name.
</ParamField>

<ParamField path="exclude_from_bom" type="bool" />

<ParamField path="override_net_name" type="str">
  When set on an interface, this will override the net name of the interface.

  This is useful for renaming nets which are automatically generated.
</ParamField>

<ParamField path="required" type="bool">
  Only for ModuleInterfaces.
  If set to `True`, require that interface is connected to something outside
  of the module it's defined in.
</ParamField>

<RequestExample>
  ```ato Basic Usage theme={null}
  import SWD, ElectricPower, Resistor

  swd = new SWD

  # Connect power reference for logic levels
  power_3v3 = new ElectricPower
  assert power_3v3.voltage within 3.3V +/- 5%
  swd.clk.reference ~ power_3v3
  swd.dio.reference ~ power_3v3
  swd.swo.reference ~ power_3v3
  swd.reset.reference ~ power_3v3

  # Connect to microcontroller SWD interface
  microcontroller.swd_clk ~ swd.clk.line
  microcontroller.swd_dio ~ swd.dio.line
  microcontroller.swd_swo ~ swd.swo.line
  microcontroller.reset_n ~ swd.reset.line

  # Connect to debugger/programmer
  debugger.swd ~ swd

  # Optional pullup resistors for robust operation
  reset_pullup = new Resistor
  reset_pullup.resistance = 10kohm +/- 5%
  swd.reset.line ~> reset_pullup ~> power_3v3.hv

  # SWD is commonly used for ARM Cortex-M debugging and programming
  ```
</RequestExample>