luna_soc.gateware.core.usb2.ep_in module

Implementation of a Triple-FIFO endpoint manager.

Equivalent (but not binary-compatbile) implementation of ValentyUSB’s eptri.

For an example, see examples/usb/eptri or TinyUSB’s luna/dcd_eptri.c.

class luna_soc.gateware.core.usb2.ep_in.Peripheral(*args, src_loc_at=0, **kwargs)[source]

Bases: Component

IN component of our eptri-equivalent interface.

Implements the FIFO that handles eptri IN requests. This FIFO collects USB data, and transmits it in response to an IN token. Like all eptri interfaces; it can handle only one pending packet at a time.

Attributes

interface: EndpointInterface: Our primary interface to the core USB device hardware.

class Data(*args, src_loc_at=0, **kwargs)[source]

Bases: Register

A CSR register.

Parameters

fieldsdict or list or Field: Collection of register fields. If None (default), a dict is populated from Python variable annotations. fields is used to create a FieldActionMap, FieldActionArray, or FieldAction, depending on its type (dict, list, or Field).

Interface attributes

elementElement: Interface between this register and a CSR bus primitive.

Attributes

fieldFieldActionMap or FieldActionArray or FieldAction: Collection of field instances.
fFieldActionMap or FieldActionArray or FieldAction: Shorthand for Register.field.

Raises

TypeError: If fields is neither None, a dict, a list, or a Field.
ValueError: If fields is not None and at least one variable annotation is a Field.
ValueError: If element.access is not readable and at least one field is readable.
ValueError: If element.access is not writable and at least one field is writable.

byte: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f6e0>

class Endpoint(*args, src_loc_at=0, **kwargs)[source]

Bases: Register

A CSR register.

Parameters

fieldsdict or list or Field: Collection of register fields. If None (default), a dict is populated from Python variable annotations. fields is used to create a FieldActionMap, FieldActionArray, or FieldAction, depending on its type (dict, list, or Field).

Interface attributes

elementElement: Interface between this register and a CSR bus primitive.

Attributes

fieldFieldActionMap or FieldActionArray or FieldAction: Collection of field instances.
fFieldActionMap or FieldActionArray or FieldAction: Shorthand for Register.field.

Raises

TypeError: If fields is neither None, a dict, a list, or a Field.
ValueError: If fields is not None and at least one variable annotation is a Field.
ValueError: If element.access is not readable and at least one field is readable.
ValueError: If element.access is not writable and at least one field is writable.

number: <amaranth_soc.csr.reg.Field object at 0x7f6320b0eea0>

class Pid(*args, src_loc_at=0, **kwargs)[source]

Bases: Register

A CSR register.

Parameters

fieldsdict or list or Field: Collection of register fields. If None (default), a dict is populated from Python variable annotations. fields is used to create a FieldActionMap, FieldActionArray, or FieldAction, depending on its type (dict, list, or Field).

Interface attributes

elementElement: Interface between this register and a CSR bus primitive.

Attributes

fieldFieldActionMap or FieldActionArray or FieldAction: Collection of field instances.
fFieldActionMap or FieldActionArray or FieldAction: Shorthand for Register.field.

Raises

TypeError: If fields is neither None, a dict, a list, or a Field.
ValueError: If fields is not None and at least one variable annotation is a Field.
ValueError: If element.access is not readable and at least one field is readable.
ValueError: If element.access is not writable and at least one field is writable.

toggle: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f0b0>

class Reset(*args, src_loc_at=0, **kwargs)[source]

Bases: Register

A CSR register.

Parameters

fieldsdict or list or Field: Collection of register fields. If None (default), a dict is populated from Python variable annotations. fields is used to create a FieldActionMap, FieldActionArray, or FieldAction, depending on its type (dict, list, or Field).

Interface attributes

elementElement: Interface between this register and a CSR bus primitive.

Attributes

fieldFieldActionMap or FieldActionArray or FieldAction: Collection of field instances.
fFieldActionMap or FieldActionArray or FieldAction: Shorthand for Register.field.

Raises

TypeError: If fields is neither None, a dict, a list, or a Field.
ValueError: If fields is not None and at least one variable annotation is a Field.
ValueError: If element.access is not readable and at least one field is readable.
ValueError: If element.access is not writable and at least one field is writable.

fifo: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f5c0>

class Stall(*args, src_loc_at=0, **kwargs)[source]

Bases: Register

A CSR register.

Parameters

fieldsdict or list or Field: Collection of register fields. If None (default), a dict is populated from Python variable annotations. fields is used to create a FieldActionMap, FieldActionArray, or FieldAction, depending on its type (dict, list, or Field).

Interface attributes

elementElement: Interface between this register and a CSR bus primitive.

Attributes

fieldFieldActionMap or FieldActionArray or FieldAction: Collection of field instances.
fFieldActionMap or FieldActionArray or FieldAction: Shorthand for Register.field.

Raises

TypeError: If fields is neither None, a dict, a list, or a Field.
ValueError: If fields is not None and at least one variable annotation is a Field.
ValueError: If element.access is not readable and at least one field is readable.
ValueError: If element.access is not writable and at least one field is writable.

stalled: <amaranth_soc.csr.reg.Field object at 0x7f6320b0ef90>

class Status(*args, src_loc_at=0, **kwargs)[source]

Bases: Register

A CSR register.

Parameters

fieldsdict or list or Field: Collection of register fields. If None (default), a dict is populated from Python variable annotations. fields is used to create a FieldActionMap, FieldActionArray, or FieldAction, depending on its type (dict, list, or Field).

Interface attributes

elementElement: Interface between this register and a CSR bus primitive.

Attributes

fieldFieldActionMap or FieldActionArray or FieldAction: Collection of field instances.
fFieldActionMap or FieldActionArray or FieldAction: Shorthand for Register.field.

Raises

TypeError: If fields is neither None, a dict, a list, or a Field.
ValueError: If fields is not None and at least one variable annotation is a Field.
ValueError: If element.access is not readable and at least one field is readable.
ValueError: If element.access is not writable and at least one field is writable.

epno: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f260>

have: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f410>

idle: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f380>

nak: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f1d0>

pid: <amaranth_soc.csr.reg.Field object at 0x7f6320b0f4a0>

__init__(max_packet_size=512)[source]

Parameters

max_packet_size: int, optional
Sets the maximum packet size that can be transmitted on this endpoint. This should match the value provided in the relevant endpoint descriptor.

elaborate(platform)[source]