gostlink

package module

v0.0.0-...-4a92bb6 Latest Latest Go to latest Published: Oct 14, 2020 License: GPL-3.0 Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bbnote/gostlink

README ¶

goST-Link library

About

Go library that provides support for interacting with ST-Link (> V2) to read out ram or SWO messages. It also includes a simple SeggerRTT interface which provides support for real time transfer.

The usb interface is based on the OpenOCD project https://sourceforge.net/p/openocd/code

The rtt implemenation ist based on phryniszak reversed engineered strtt library https://github.com/phryniszak/strtt

Usage

For usage see in stRttLogger/

Installation under Windows

Gostlink uses the gousb package. For installation see:

https://github.com/google/gousb

Documentation ¶

Index ¶

Constants
func CloseUSB()
func InitUsb() error
func SetLogger(loggerInstance *logrus.Logger)
type Buffer
- func NewBuffer(initSize int) *Buffer
- func (buf *Buffer) ReadUint16BE() uint16
- func (buf *Buffer) ReadUint16LE() uint16
- func (buf *Buffer) ReadUint32BE() uint32
- func (buf *Buffer) ReadUint32LE() uint32
- func (buf *Buffer) WriteUint16LE(value uint16)
- func (buf *Buffer) WriteUint32LE(value uint32)
type Endian
type MemoryBlockSize
type RttDataCb
type StLink
- func NewStLink(config *StLinkInterfaceConfig) (*StLink, error)
- func (h *StLink) Close()
- func (h *StLink) ConfigTrace(enabled bool, tpiuProtocol TpuiPinProtocolType, portSize uint32, ...) error
- func (h *StLink) GetIdCode() (uint32, error)
- func (h *StLink) GetTargetVoltage() (float32, error)
- func (h *StLink) InitializeRtt(rttSearchRanges [][2]uint64) error
- func (h *StLink) PollTrace(buffer []byte, size *uint32) error
- func (h *StLink) ReadMem(addr uint32, bitLength MemoryBlockSize, count uint32, buffer *bytes.Buffer) error
- func (h *StLink) ReadRttChannels(callback RttDataCb) error
- func (h *StLink) Reset()
- func (h *StLink) SetSpeed(khz uint32, query bool) (uint32, error)
- func (h *StLink) UpdateRttChannels(readChannelNames bool) error
- func (h *StLink) WriteMem(address uint32, bitLength MemoryBlockSize, count uint32, buffer []byte) error
type StLinkInterfaceConfig
- func NewStLinkConfig(vid gousb.ID, pid gousb.ID, mode StLinkMode, serial string, ...) *StLinkInterfaceConfig
type StLinkMode
type StmCpuInfo
- func GetCpuInformation(cpuId string) *StmCpuInfo
type TpuiPinProtocolType
type TraceConfigType

Constants ¶

View Source

const (
	StLinkModeUnknown   StLinkMode = 0
	StLinkModeDfu                  = 1
	StLinkModeMass                 = 2
	StLinkModeDebugJtag            = 3
	StLinkModeDebugSwd             = 4
	StLinkModeDebugSwim            = 5
)

View Source

const (
	Memory8BitBlock  MemoryBlockSize = 1
	Memory16BitBlock                 = 2
	Memory32BitBlock                 = 4
)

View Source

const (
	SeggerRttModeNoBlockSkip     seggerRttMode = 0
	SeggerRttModeNoBlockTrim                   = 1
	SeggerRttModeBlockIfFifoFull               = 2
)

View Source

const (
	TraceConfigTypeDisabled TraceConfigType = 0 // tracing is disabled
	TraceConfigTypeExternal                 = 1 // trace output is captured externally
	TraceConfigTypeInternal                 = 2 // trace output is handled by OpenOCD adapter driver
)

View Source

const (
	TpuiPinProtocolSync           TpuiPinProtocolType = 0 // synchronous trace output
	TpuiPinProtocolAsynManchester                     = 1 // asynchronous output with Manchester coding
	TpuiPinProtocolAsyncUart                          = 2 // asynchronous output with NRZ coding
)

View Source

const AllSupportedPIds = 0xFFFF

View Source

const AllSupportedVIds = 0xFFFF

View Source

const (
	DefaultRamStart = 0x20000000
)

Variables ¶

This section is empty.

Functions ¶

func CloseUSB ¶

func CloseUSB()

func InitUsb ¶

func InitUsb() error

func SetLogger ¶

func SetLogger(loggerInstance *logrus.Logger)

Types ¶

type Buffer ¶

type Buffer struct {
	bytes.Buffer
}

func NewBuffer ¶

func NewBuffer(initSize int) *Buffer

func (*Buffer) ReadUint16BE ¶

func (buf *Buffer) ReadUint16BE() uint16

func (*Buffer) ReadUint16LE ¶

func (buf *Buffer) ReadUint16LE() uint16

func (*Buffer) ReadUint32BE ¶

func (buf *Buffer) ReadUint32BE() uint32

func (*Buffer) ReadUint32LE ¶

func (buf *Buffer) ReadUint32LE() uint32

func (*Buffer) WriteUint16LE ¶

func (buf *Buffer) WriteUint16LE(value uint16)

func (*Buffer) WriteUint32LE ¶

func (buf *Buffer) WriteUint32LE(value uint32)

type Endian ¶

type Endian uint8

type MemoryBlockSize ¶

type MemoryBlockSize int // block size for read and write operations

type RttDataCb ¶

type RttDataCb func(int, []byte) error

type StLink ¶

type StLink struct {
	// contains filtered or unexported fields
}

*

func NewStLink ¶

func NewStLink(config *StLinkInterfaceConfig) (*StLink, error)

func (*StLink) Close ¶

func (h *StLink) Close()

func (*StLink) ConfigTrace ¶

func (h *StLink) ConfigTrace(enabled bool, tpiuProtocol TpuiPinProtocolType, portSize uint32,
	traceFreq *uint32, traceClkInFreq uint32, preScaler *uint16) error

func (*StLink) GetIdCode ¶

func (h *StLink) GetIdCode() (uint32, error)

func (*StLink) GetTargetVoltage ¶

func (h *StLink) GetTargetVoltage() (float32, error)

func (*StLink) InitializeRtt ¶

func (h *StLink) InitializeRtt(rttSearchRanges [][2]uint64) error

func (*StLink) PollTrace ¶

func (h *StLink) PollTrace(buffer []byte, size *uint32) error

func (*StLink) ReadMem ¶

func (h *StLink) ReadMem(addr uint32, bitLength MemoryBlockSize, count uint32, buffer *bytes.Buffer) error

func (*StLink) ReadRttChannels ¶

func (h *StLink) ReadRttChannels(callback RttDataCb) error

func (*StLink) Reset ¶

func (h *StLink) Reset()

func (*StLink) SetSpeed ¶

func (h *StLink) SetSpeed(khz uint32, query bool) (uint32, error)

func (*StLink) UpdateRttChannels ¶

func (h *StLink) UpdateRttChannels(readChannelNames bool) error

func (*StLink) WriteMem ¶

func (h *StLink) WriteMem(address uint32, bitLength MemoryBlockSize, count uint32, buffer []byte) error

type StLinkInterfaceConfig ¶

type StLinkInterfaceConfig struct {
	// contains filtered or unexported fields
}

func NewStLinkConfig ¶

func NewStLinkConfig(vid gousb.ID, pid gousb.ID, mode StLinkMode,
	serial string, initialSpeed uint32, connectUnderReset bool) *StLinkInterfaceConfig

type StLinkMode ¶

type StLinkMode uint8 // stlink debug modes

type StmCpuInfo ¶

type StmCpuInfo struct {
	RamStart uint64
	RamSize  uint64
}

func GetCpuInformation ¶

func GetCpuInformation(cpuId string) *StmCpuInfo

type TpuiPinProtocolType ¶

type TpuiPinProtocolType int

type TraceConfigType ¶

type TraceConfigType int

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
stRttLogger

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL