eth

Documentation

Index

• type Buffer
• type Client
  • func NewClient(clientName string, topopath, filepath string, device ethernet.DeviceWithCtx) (*Client, error)
  • func (*Client) ARPHardwareType() header.ARPHardwareType
  • func (*Client) AddHeader(_, _ tcpip.LinkAddress, _ tcpip.NetworkProtocolNumber, _ *stack.PacketBuffer)
  • func (c *Client) Attach(dispatcher stack.NetworkDispatcher)
  • func (c *Client) Capabilities() stack.LinkEndpointCapabilities
  • func (c *Client) Close() error
  • func (c *Client) DeviceClass() network.DeviceClass
  • func (c *Client) Down() error
  • func (c *Client) Filepath() string
  • func (c *Client) GSOMaxSize() uint32
  • func (c *Client) IsAttached() bool
  • func (c *Client) LinkAddress() tcpip.LinkAddress
  • func (c *Client) ListenTX() error
  • func (c *Client) MTU() uint32
  • func (c *Client) MaxHeaderLength() uint16
  • func (c *Client) RxStats() *fifo.RxStats
  • func (c *Client) SetOnLinkClosed(f func())
  • func (c *Client) SetOnLinkOnlineChanged(f func(bool))
  • func (c *Client) SetPromiscuousMode(enabled bool) error
  • func (c *Client) Topopath() string
  • func (c *Client) TxStats() *fifo.TxStats
  • func (c *Client) Up() error
  • func (c *Client) Wait()
  • func (c *Client) WritePacket(_ stack.RouteInfo, _ *stack.GSO, _ tcpip.NetworkProtocolNumber, ...) tcpip.Error
  • func (c *Client) WritePackets(_ stack.RouteInfo, _ *stack.GSO, pkts stack.PacketBufferList, ...) (int, tcpip.Error)
• type IOBuffer
  • func (iob *IOBuffer) BufferFromEntry(e eth.FifoEntry) Buffer

Types

type Buffer

type Buffer []byte

Buffer is a segment of memory backed by a mapped VMO.

A Buffer must not outlive its VMO's mapping. A Buffer's head must not change (by slicing or appending).

type Client

type Client struct {
	Info ethernet.Info
	// contains filtered or unexported fields
}

Client is an ethernet client.

It connects to a zircon ethernet driver using a FIFO-based protocol. The protocol is described in system/fidl/fuchsia-hardware-ethernet/ethernet.fidl.

func NewClient

func NewClient(clientName string, topopath, filepath string, device ethernet.DeviceWithCtx) (*Client, error)

NewClient creates a new ethernet Client.

func (*Client) ARPHardwareType

func (*Client) ARPHardwareType() header.ARPHardwareType

ARPHardwareType implements stack.LinkEndpoint.

func (*Client) AddHeader

func (*Client) AddHeader(_, _ tcpip.LinkAddress, _ tcpip.NetworkProtocolNumber, _ *stack.PacketBuffer)

AddHeader implements stack.LinkEndpoint.

func (*Client) Attach

func (c *Client) Attach(dispatcher stack.NetworkDispatcher)

func (*Client) Capabilities

func (c *Client) Capabilities() stack.LinkEndpointCapabilities

func (*Client) Close

func (c *Client) Close() error

Close closes a Client, releasing any held resources.

func (*Client) DeviceClass

func (c *Client) DeviceClass() network.DeviceClass

func (*Client) Down

func (c *Client) Down() error

Down disables the interface.

func (*Client) Filepath

func (c *Client) Filepath() string

func (*Client) GSOMaxSize

func (c *Client) GSOMaxSize() uint32

func (*Client) IsAttached

func (c *Client) IsAttached() bool

func (*Client) LinkAddress

func (c *Client) LinkAddress() tcpip.LinkAddress

func (*Client) ListenTX

func (c *Client) ListenTX() error

ListenTX tells the ethernet driver to reflect all transmitted packets back to this ethernet client.

func (*Client) MTU

func (c *Client) MTU() uint32

func (*Client) MaxHeaderLength

func (c *Client) MaxHeaderLength() uint16

func (*Client) RxStats

func (c *Client) RxStats() *fifo.RxStats

func (*Client) SetOnLinkClosed

func (c *Client) SetOnLinkClosed(f func())

func (*Client) SetOnLinkOnlineChanged

func (c *Client) SetOnLinkOnlineChanged(f func(bool))

func (*Client) SetPromiscuousMode

func (c *Client) SetPromiscuousMode(enabled bool) error

func (*Client) Topopath

func (c *Client) Topopath() string

func (*Client) TxStats

func (c *Client) TxStats() *fifo.TxStats

func (*Client) Up

func (c *Client) Up() error

Up enables the interface.

func (*Client) Wait

func (c *Client) Wait()

Wait implements stack.LinkEndpoint. It blocks until an error in the dispatch goroutine(s) spawned in Attach occurs.

func (*Client) WritePacket

func (c *Client) WritePacket(_ stack.RouteInfo, _ *stack.GSO, _ tcpip.NetworkProtocolNumber, pkt *stack.PacketBuffer) tcpip.Error

func (*Client) WritePackets

func (c *Client) WritePackets(_ stack.RouteInfo, _ *stack.GSO, pkts stack.PacketBufferList, _ tcpip.NetworkProtocolNumber) (int, tcpip.Error)

type IOBuffer

type IOBuffer struct {
	fifo.MappedVMO
}

func (*IOBuffer) BufferFromEntry

func (iob *IOBuffer) BufferFromEntry(e eth.FifoEntry) Buffer