op

Documentation

Overview

Package op contains available SPI opcodes. The opcode is typically sent at the beginning of a SPI transaction.

Index

• type OpCode
  • func (o OpCode) Bytes() []byte
  • func (o OpCode) String() string
• type Status
  • func (status Status) Busy() bool
  • func (status Status) String() string

Types

type OpCode

type OpCode byte

const (
	// PageProgram programs a page on the flash chip.
	PageProgram OpCode = 0x02
	// Read reads from the flash chip.
	Read OpCode = 0x03
	// WriteDisable disables writing.
	WriteDisable OpCode = 0x04
	// ReadStatus reads the status register.
	ReadStatus OpCode = 0x05
	// WriteEnable enables writing.
	WriteEnable OpCode = 0x06
	// SectorErase erases a sector to the value 0xff.
	SectorErase OpCode = 0x20
	// ReadSFDP reads from the SFDP.
	ReadSFDP OpCode = 0x5a
	// ReadID reads the JEDEC ID.
	ReadJEDECID OpCode = 0x9f
	// PRD/RES
	PRDRES OpCode = 0xab
	// AAI is auto address increment
	AAI OpCode = 0xad
	// Enter4BA enters 4-OpCode addressing mode.
	Enter4BA OpCode = 0xb7
	// BlockErase erases a block to the value 0xff.
	BlockErase OpCode = 0xd8
	// Exit4BA exits 4-OpCode addressing mode.
	Exit4BA OpCode = 0xe9
)

func (OpCode) Bytes

func (o OpCode) Bytes() []byte

func (OpCode) String

func (o OpCode) String() string

type Status

type Status byte

const (
	WriteBusy Status = 1 << iota
	WriteEnabled
	ByteProtect0
	ByteProtect1
	ByteProtect2
	ByteProtectP3
	AutoAddressIncrement
	ByteProtectLocked
)

Status is not universally defined, but a few bits are common.

func (Status) Busy

func (status Status) Busy() bool

func (Status) String

func (status Status) String() string