HOCD.Monad

Documentation

data OCDT m a

Instances

MonadTrans OCDT

Defined in HOCD.Monad

Methods

lift :: Monad m => m a -> OCDT m a

Monad m => MonadError OCDError (OCDT m)

Defined in HOCD.Monad

Methods

throwError :: OCDError -> OCDT m a

catchError :: OCDT m a -> (OCDError -> OCDT m a) -> OCDT m a

Monad m => MonadReader Socket (OCDT m)

Defined in HOCD.Monad

Methods

ask :: OCDT m Socket

local :: (Socket -> Socket) -> OCDT m a -> OCDT m a

reader :: (Socket -> a) -> OCDT m a

MonadIO m => MonadIO (OCDT m)

Defined in HOCD.Monad

Methods

liftIO :: IO a -> OCDT m a

Monad m => Applicative (OCDT m)

Defined in HOCD.Monad

Methods

pure :: a -> OCDT m a

(<*>) :: OCDT m (a -> b) -> OCDT m a -> OCDT m b

liftA2 :: (a -> b -> c) -> OCDT m a -> OCDT m b -> OCDT m c

(*>) :: OCDT m a -> OCDT m b -> OCDT m b

(<*) :: OCDT m a -> OCDT m b -> OCDT m a

Functor m => Functor (OCDT m)

Defined in HOCD.Monad

Methods

fmap :: (a -> b) -> OCDT m a -> OCDT m b

(<$) :: a -> OCDT m b -> OCDT m a

Monad m => Monad (OCDT m)

Defined in HOCD.Monad

Methods

(>>=) :: OCDT m a -> (a -> OCDT m b) -> OCDT m b

(>>) :: OCDT m a -> OCDT m b -> OCDT m b

return :: a -> OCDT m a

MonadCatch m => MonadCatch (OCDT m)

Defined in HOCD.Monad

Methods

catch :: (HasCallStack, Exception e) => OCDT m a -> (e -> OCDT m a) -> OCDT m a

MonadMask m => MonadMask (OCDT m)

Defined in HOCD.Monad

Methods

mask :: HasCallStack => ((forall a. OCDT m a -> OCDT m a) -> OCDT m b) -> OCDT m b

uninterruptibleMask :: HasCallStack => ((forall a. OCDT m a -> OCDT m a) -> OCDT m b) -> OCDT m b

generalBracket :: HasCallStack => OCDT m a -> (a -> ExitCase b -> OCDT m c) -> (a -> OCDT m b) -> OCDT m (b, c)

MonadThrow m => MonadThrow (OCDT m)

Defined in HOCD.Monad

Methods

throwM :: (HasCallStack, Exception e) => e -> OCDT m a

MonadIO m => MonadOCD (OCDT m)

Defined in HOCD.Monad

Methods

getSocket :: OCDT m Socket

runOCDT :: Monad m => Socket -> OCDT m a -> m (Either OCDError a)

Run OCDT transformer

class (MonadIO m, MonadError OCDError m) => MonadOCD m where

Minimal complete definition

Nothing

Methods

getSocket :: m Socket

default getSocket :: (MonadTrans t, MonadOCD m', m ~ t m') => m Socket

Instances

MonadIO m => MonadOCD (OCDT m)

Defined in HOCD.Monad

Methods

getSocket :: OCDT m Socket

MonadOCD m => MonadOCD (ExceptT OCDError m)

Defined in HOCD.Monad

Methods

getSocket :: ExceptT OCDError m Socket

MonadOCD m => MonadOCD (ReaderT r m)

Defined in HOCD.Monad

Methods

getSocket :: ReaderT r m Socket

MonadOCD m => MonadOCD (StateT s m)

Defined in HOCD.Monad

Methods

getSocket :: StateT s m Socket

halt :: MonadOCD m => m ByteString

Halt target

halt' :: MonadOCD m => m ()

Halt target, discarding reply

reset :: MonadOCD m => m ()

Reset target (default "reset run")

resetHalt :: MonadOCD m => m ()

Reset target and halt execution

resetHaltInit :: MonadOCD m => m ()

Reset target, halt execution and execute reset-init script

resume :: MonadOCD m => m ()

Resume execution

resumeAt :: MonadOCD m => MemAddress -> m ()

Resume execution at MemAddress

step :: MonadOCD m => m ()

Single-step target at its current code position

stepTo :: MonadOCD m => MemAddress -> m ()

Single-step target to code position at MemAddress

readMem

Arguments

:: forall a m. (MonadOCD m, FiniteBits a, Integral a)

=> MemAddress

Memory address to read from

-> m a

Read single memory segment from MemAddress Segment size depends on Word type.

readMem32

Arguments

:: MonadOCD m

=> MemAddress

Memory address to read from

-> m Word32

Shorthand for reading Word32 sized segment

readMemCount

Arguments

:: forall a m. (MonadOCD m, FiniteBits a, Integral a)

=> MemAddress

Memory address to read from

-> Int

Count

-> m [a]

Read multiple memory segments from MemAddress according to count argument. Segment size depends on Word type.

writeMem

Arguments

:: forall a m. (MonadOCD m, FiniteBits a, PrintfArg a, Integral a)

=> MemAddress

Memory address to write to

-> [a]

Data to write

-> m ()

Write multiple memory segments to MemAddress

writeMem32

Arguments

:: MonadOCD m

=> MemAddress

Memory address to write to

-> [Word32]

Data to write

-> m ()

Shorthand for writing Word32 sized segment

registers :: MonadOCD m => m (Map RegisterName RegisterInfo)

readReg

Arguments

:: forall a m. (MonadOCD m, FiniteBits a, Integral a)

=> RegisterName

Name of the register to query

-> m a

Read a CPU register

writeReg

Arguments

:: forall a m. (MonadOCD m, FiniteBits a, Integral a, PrintfArg a)

=> RegisterName

Name of the register to write to

-> a

Value to write

-> m ()

Write a CPU register

version :: MonadOCD m => m ByteString

Query OpenOCD version

raw :: MonadOCD m => ByteString -> m ByteString

Send raw OpenOCD command Escape hatch for commands that are not part defined as part of hocd api