common

Documentation

Overview

Copyright (c) 2014-2019 Cesanta Software Limited All rights reserved

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2014-2019 Cesanta Software Limited All rights reserved

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2014-2019 Cesanta Software Limited All rights reserved

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func LimitStr(b []byte, n int) string
• func OpenUSBDevice(vid, pid gousb.ID, serial string) (*gousb.Context, *gousb.Device, error)
• func Reportf(f string, args ...interface{})
• type SLIPReaderWriter
  • func NewSLIPReaderWriter(rw io.ReadWriter) *SLIPReaderWriter
  • func (srw *SLIPReaderWriter) Read(buf []byte) (int, error)
  • func (srw *SLIPReaderWriter) Write(data []byte) (int, error)
• type Target
• type TargetMemReader
• type TargetMemReaderWriter
• type TargetMemWriter

Functions

func LimitStr

func LimitStr(b []byte, n int) string

func OpenUSBDevice

func OpenUSBDevice(vid, pid gousb.ID, serial string) (*gousb.Context, *gousb.Device, error)

OpenUSBDevice opens a USB device with specified VID, PID and (optionally) serial number. If serial number is empty, it is not checked. If multiple devices match the criteria, one of them will be returned.

func Reportf

func Reportf(f string, args ...interface{})

Types

type SLIPReaderWriter

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

func NewSLIPReaderWriter

func NewSLIPReaderWriter(rw io.ReadWriter) *SLIPReaderWriter

func (*SLIPReaderWriter) Read

func (srw *SLIPReaderWriter) Read(buf []byte) (int, error)

func (*SLIPReaderWriter) Write

func (srw *SLIPReaderWriter) Write(data []byte) (int, error)

type Target

type Target interface {
	// ResetRun resets the system and lets it run without debug.
	ResetRun(ctx context.Context) error
	// ResetHalt performs reset and halts the system in debug mode.
	ResetHalt(ctx context.Context) error
	// GetReg retrieves current value of a core register.
	GetReg(ctx context.Context, reg int) (uint32, error)
	// SetReg sets value of a core register.
	SetReg(ctx context.Context, reg int, value uint32) error
	// GetRegs retrieves current values of the core registers.
	GetRegs(ctx context.Context, regFilePtr interface{}) error
	// SetRegs sets values of the core registers.
	SetRegs(ctx context.Context, regFile interface{}) error
	// Run releases the processor from halt and lets it run (from current instruction pointer).
	// If waitHalt is set, will wait for the processor to halt again before returning.
	Run(ctx context.Context, waitHalt bool) error
	// WaitHalt waits for core to halt.
	WaitHalt(ctx context.Context) error
}

type TargetMemReader

type TargetMemReader interface {
	// ReadTargetReg reads a single 32-bit word from the target (handy for reading registers).
	ReadTargetReg(ctx context.Context, addr uint32) (uint32, error)
	// ReadTargetMem reads length bytes at the specified address in the target's memory.
	// Both addr and length must be word-aligned.
	ReadTargetMem(ctx context.Context, addr uint32, length int) ([]uint32, error)
}

type TargetMemReaderWriter

type TargetMemReaderWriter interface {
	TargetMemReader
	TargetMemWriter
}

type TargetMemWriter

type TargetMemWriter interface {
	// WriteTargetReg writes a single 32-bit word to the target.
	WriteTargetReg(ctx context.Context, addr uint32, value uint32) error
	// WriteTargetMem writes data at the specified address to the target's memory.
	// addr must be word-aligned.
	WriteTargetMem(ctx context.Context, addr uint32, data []uint32) error
}