Safe Haskell	Safe-Inferred
Language	Haskell2010

HOCD.Monad

Synopsis

data OCDT m a
runOCDT :: Monad m => Socket -> OCDT m a -> m (Either OCDError a)
class (MonadIO m, MonadError OCDError m) => MonadOCD m where
- getSocket :: m Socket
halt :: MonadOCD m => m ByteString
halt' :: MonadOCD m => m ()
reset :: MonadOCD m => m ()
resetHalt :: MonadOCD m => m ()
resetHaltInit :: MonadOCD m => m ()
resume :: MonadOCD m => m ()
resumeAt :: MonadOCD m => MemAddress -> m ()
step :: MonadOCD m => m ()
stepTo :: MonadOCD m => MemAddress -> m ()
readMem :: forall a m. (MonadOCD m, FiniteBits a, Integral a) => MemAddress -> m a
readMem32 :: MonadOCD m => MemAddress -> m Word32
readMemCount :: forall a m. (MonadOCD m, FiniteBits a, Integral a) => MemAddress -> Int -> m [a]
writeMem :: forall a m. (MonadOCD m, FiniteBits a, PrintfArg a, Integral a) => MemAddress -> [a] -> m ()
writeMem32 :: MonadOCD m => MemAddress -> [Word32] -> m ()
registers :: MonadOCD m => m (Map RegisterName RegisterInfo)
readReg :: forall a m. (MonadOCD m, FiniteBits a, Integral a) => RegisterName -> m a
writeReg :: forall a m. (MonadOCD m, FiniteBits a, Integral a, PrintfArg a) => RegisterName -> a -> m ()
version :: MonadOCD m => m ByteString
raw :: MonadOCD m => ByteString -> m ByteString

Documentation

data OCDT m a Source #

Instances

Instances details

MonadTrans OCDT Source #
Instance details Defined in HOCD.Monad Methods lift :: Monad m => m a -> OCDT m a #
Monad m => MonadError OCDError (OCDT m) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in HOCD.Monad Methods liftIO :: IO a -> OCDT m a #
Monad m => Applicative (OCDT m) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in HOCD.Monad Methods catch :: (HasCallStack, Exception e) => OCDT m a -> (e -> OCDT m a) -> OCDT m a #
MonadMask m => MonadMask (OCDT m) Source #
Instance details 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) Source #
Instance details Defined in HOCD.Monad Methods throwM :: (HasCallStack, Exception e) => e -> OCDT m a #
MonadIO m => MonadOCD (OCDT m) Source #
Instance details Defined in HOCD.Monad Methods getSocket :: OCDT m Socket Source #

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

Run OCDT transformer

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

Minimal complete definition

Nothing

Methods

getSocket :: m Socket Source #

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

Instances

Instances details

MonadIO m => MonadOCD (OCDT m) Source #
Instance details Defined in HOCD.Monad Methods getSocket :: OCDT m Socket Source #
MonadOCD m => MonadOCD (ExceptT OCDError m) Source #
Instance details Defined in HOCD.Monad Methods getSocket :: ExceptT OCDError m Socket Source #
MonadOCD m => MonadOCD (ReaderT r m) Source #
Instance details Defined in HOCD.Monad Methods getSocket :: ReaderT r m Socket Source #
MonadOCD m => MonadOCD (StateT s m) Source #
Instance details Defined in HOCD.Monad Methods getSocket :: StateT s m Socket Source #

halt :: MonadOCD m => m ByteString Source #

Halt target

halt' :: MonadOCD m => m () Source #

Halt target, discarding reply

reset :: MonadOCD m => m () Source #

Reset target (default "reset run")

resetHalt :: MonadOCD m => m () Source #

Reset target and halt execution

resetHaltInit :: MonadOCD m => m () Source #

Reset target, halt execution and execute reset-init script

resume :: MonadOCD m => m () Source #

Resume execution

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

Resume execution at MemAddress

step :: MonadOCD m => m () Source #

Single-step target at its current code position

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

Single-step target to code position at MemAddress

readMem Source #

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 Source #

Arguments

:: MonadOCD m
=> MemAddress	Memory address to read from
-> m Word32

Shorthand for reading Word32 sized segment

readMemCount Source #

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 Source #

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 Source #

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) Source #

readReg Source #

Arguments

:: forall a m. (MonadOCD m, FiniteBits a, Integral a)
=> RegisterName	Name of the register to query
-> m a

Read a CPU register

writeReg Source #

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 Source #

Query OpenOCD version

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

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