Hapstone.Internal.XCore

This module contains XCore specific datatypes and their respective Storable instances. Most of the types are used internally and can be looked up here. Some of them are currently unused, as the headers only define them as symbolic constants whose type is never used explicitly, which poses a problem for a memory-safe port to the Haskell language, this is about to get fixed in a future version.

Apart from that, because the module is generated using C2HS, some of the documentation is misplaced or rendered incorrectly, so if in doubt, read the source file.

Documentation

data XCoreOpType

operand type for instruction's operands

Constructors

XcoreOpInvalid

XcoreOpReg

XcoreOpImm

XcoreOpMem

Instances

Bounded XCoreOpType

Methods

minBound :: XCoreOpType

maxBound :: XCoreOpType

Enum XCoreOpType

Methods

succ :: XCoreOpType -> XCoreOpType

pred :: XCoreOpType -> XCoreOpType

toEnum :: Int -> XCoreOpType

fromEnum :: XCoreOpType -> Int

enumFrom :: XCoreOpType -> [XCoreOpType]

enumFromThen :: XCoreOpType -> XCoreOpType -> [XCoreOpType]

enumFromTo :: XCoreOpType -> XCoreOpType -> [XCoreOpType]

enumFromThenTo :: XCoreOpType -> XCoreOpType -> XCoreOpType -> [XCoreOpType]

Eq XCoreOpType

Methods

(==) :: XCoreOpType -> XCoreOpType -> Bool

(/=) :: XCoreOpType -> XCoreOpType -> Bool

Show XCoreOpType

Methods

showsPrec :: Int -> XCoreOpType -> ShowS

show :: XCoreOpType -> String

showList :: [XCoreOpType] -> ShowS

data XCoreReg

XCore registers

Constructors

XcoreRegInvalid

XcoreRegCp

XcoreRegDp

XcoreRegLr

XcoreRegSp

XcoreRegR0

XcoreRegR1

XcoreRegR2

XcoreRegR3

XcoreRegR4

XcoreRegR5

XcoreRegR6

XcoreRegR7

XcoreRegR8

XcoreRegR9

XcoreRegR10

XcoreRegR11

XcoreRegPc

XcoreRegScp

XcoreRegSsr

XcoreRegEt

XcoreRegEd

XcoreRegSed

XcoreRegKep

XcoreRegKsp

XcoreRegId

XcoreRegEnding

Instances

Bounded XCoreReg

Methods

minBound :: XCoreReg

maxBound :: XCoreReg

Enum XCoreReg

Methods

succ :: XCoreReg -> XCoreReg

pred :: XCoreReg -> XCoreReg

toEnum :: Int -> XCoreReg

fromEnum :: XCoreReg -> Int

enumFrom :: XCoreReg -> [XCoreReg]

enumFromThen :: XCoreReg -> XCoreReg -> [XCoreReg]

enumFromTo :: XCoreReg -> XCoreReg -> [XCoreReg]

enumFromThenTo :: XCoreReg -> XCoreReg -> XCoreReg -> [XCoreReg]

Eq XCoreReg

Methods

(==) :: XCoreReg -> XCoreReg -> Bool

(/=) :: XCoreReg -> XCoreReg -> Bool

Show XCoreReg

Methods

showsPrec :: Int -> XCoreReg -> ShowS

show :: XCoreReg -> String

showList :: [XCoreReg] -> ShowS

data XCoreOpMemStruct

memory access operands associated with XcoreOpMem operand type

Constructors

XCoreOpMemStruct

Fields

• base :: Word8

  base register

• index :: Word8

  index register

• disp :: Int32

  displacement/offset value

• direct :: Int32

  +1: forward, -1: backward

Instances

Eq XCoreOpMemStruct

Methods

(==) :: XCoreOpMemStruct -> XCoreOpMemStruct -> Bool

(/=) :: XCoreOpMemStruct -> XCoreOpMemStruct -> Bool

Show XCoreOpMemStruct

Methods

showsPrec :: Int -> XCoreOpMemStruct -> ShowS

show :: XCoreOpMemStruct -> String

showList :: [XCoreOpMemStruct] -> ShowS

Storable XCoreOpMemStruct

Methods

sizeOf :: XCoreOpMemStruct -> Int

alignment :: XCoreOpMemStruct -> Int

peekElemOff :: Ptr XCoreOpMemStruct -> Int -> IO XCoreOpMemStruct

pokeElemOff :: Ptr XCoreOpMemStruct -> Int -> XCoreOpMemStruct -> IO ()

peekByteOff :: Ptr b -> Int -> IO XCoreOpMemStruct

pokeByteOff :: Ptr b -> Int -> XCoreOpMemStruct -> IO ()

peek :: Ptr XCoreOpMemStruct -> IO XCoreOpMemStruct

poke :: Ptr XCoreOpMemStruct -> XCoreOpMemStruct -> IO ()

data CsXCoreOp

instruction operand

Constructors

Reg XCoreReg

register value for XcoreOpReg operands

Imm Int32

immediate value for XcoreOpImm operands

Mem XCoreOpMemStruct

baseindexdisp/direct value for XcoreOpMem operands

Undefined

invalid operand value, for XcoreOpInvalid operand

Instances

Eq CsXCoreOp

Methods

(==) :: CsXCoreOp -> CsXCoreOp -> Bool

(/=) :: CsXCoreOp -> CsXCoreOp -> Bool

Show CsXCoreOp

Methods

showsPrec :: Int -> CsXCoreOp -> ShowS

show :: CsXCoreOp -> String

showList :: [CsXCoreOp] -> ShowS

Storable CsXCoreOp

Methods

sizeOf :: CsXCoreOp -> Int

alignment :: CsXCoreOp -> Int

peekElemOff :: Ptr CsXCoreOp -> Int -> IO CsXCoreOp

pokeElemOff :: Ptr CsXCoreOp -> Int -> CsXCoreOp -> IO ()

peekByteOff :: Ptr b -> Int -> IO CsXCoreOp

pokeByteOff :: Ptr b -> Int -> CsXCoreOp -> IO ()

peek :: Ptr CsXCoreOp -> IO CsXCoreOp

poke :: Ptr CsXCoreOp -> CsXCoreOp -> IO ()

newtype CsXCore

instruction datatype

Constructors

CsXCore [CsXCoreOp]

operand list of this instruction, *MUST* have <= 8 operands, else you'll get a runtime error when you (implicitly) try to write it to memory via it's Storable instance

Instances

Eq CsXCore

Methods

(==) :: CsXCore -> CsXCore -> Bool

(/=) :: CsXCore -> CsXCore -> Bool

Show CsXCore

Methods

showsPrec :: Int -> CsXCore -> ShowS

show :: CsXCore -> String

showList :: [CsXCore] -> ShowS

Storable CsXCore

Methods

sizeOf :: CsXCore -> Int

alignment :: CsXCore -> Int

peekElemOff :: Ptr CsXCore -> Int -> IO CsXCore

pokeElemOff :: Ptr CsXCore -> Int -> CsXCore -> IO ()

peekByteOff :: Ptr b -> Int -> IO CsXCore

pokeByteOff :: Ptr b -> Int -> CsXCore -> IO ()

peek :: Ptr CsXCore -> IO CsXCore

poke :: Ptr CsXCore -> CsXCore -> IO ()

data XCoreInsn

XCore instructions

Constructors

XcoreInsInvalid

XcoreInsAdd

XcoreInsAndnot

XcoreInsAnd

XcoreInsAshr

XcoreInsBau

XcoreInsBitrev

XcoreInsBla

XcoreInsBlat

XcoreInsBl

XcoreInsBf

XcoreInsBt

XcoreInsBu

XcoreInsBru

XcoreInsByterev

XcoreInsChkct

XcoreInsClre

XcoreInsClrpt

XcoreInsClrsr

XcoreInsClz

XcoreInsCrc8

XcoreInsCrc32

XcoreInsDcall

XcoreInsDentsp

XcoreInsDgetreg

XcoreInsDivs

XcoreInsDivu

XcoreInsDrestsp

XcoreInsDret

XcoreInsEcallf

XcoreInsEcallt

XcoreInsEdu

XcoreInsEef

XcoreInsEet

XcoreInsEeu

XcoreInsEndin

XcoreInsEntsp

XcoreInsEq

XcoreInsExtdp

XcoreInsExtsp

XcoreInsFreer

XcoreInsFreet

XcoreInsGetd

XcoreInsGet

XcoreInsGetn

XcoreInsGetr

XcoreInsGetsr

XcoreInsGetst

XcoreInsGetts

XcoreInsInct

XcoreInsInit

XcoreInsInpw

XcoreInsInshr

XcoreInsInt

XcoreInsIn

XcoreInsKcall

XcoreInsKentsp

XcoreInsKrestsp

XcoreInsKret

XcoreInsLadd

XcoreInsLd16s

XcoreInsLd8u

XcoreInsLda16

XcoreInsLdap

XcoreInsLdaw

XcoreInsLdc

XcoreInsLdw

XcoreInsLdivu

XcoreInsLmul

XcoreInsLss

XcoreInsLsub

XcoreInsLsu

XcoreInsMaccs

XcoreInsMaccu

XcoreInsMjoin

XcoreInsMkmsk

XcoreInsMsync

XcoreInsMul

XcoreInsNeg

XcoreInsNot

XcoreInsOr

XcoreInsOutct

XcoreInsOutpw

XcoreInsOutshr

XcoreInsOutt

XcoreInsOut

XcoreInsPeek

XcoreInsRems

XcoreInsRemu

XcoreInsRetsp

XcoreInsSetclk

XcoreInsSet

XcoreInsSetc

XcoreInsSetd

XcoreInsSetev

XcoreInsSetn

XcoreInsSetpsc

XcoreInsSetpt

XcoreInsSetrdy

XcoreInsSetsr

XcoreInsSettw

XcoreInsSetv

XcoreInsSext

XcoreInsShl

XcoreInsShr

XcoreInsSsync

XcoreInsSt16

XcoreInsSt8

XcoreInsStw

XcoreInsSub

XcoreInsSyncr

XcoreInsTestct

XcoreInsTestlcl

XcoreInsTestwct

XcoreInsTsetmr

XcoreInsStart

XcoreInsWaitef

XcoreInsWaitet

XcoreInsWaiteu

XcoreInsXor

XcoreInsZext

XcoreInsEnding

Instances

Bounded XCoreInsn

Methods

minBound :: XCoreInsn

maxBound :: XCoreInsn

Enum XCoreInsn

Methods

succ :: XCoreInsn -> XCoreInsn

pred :: XCoreInsn -> XCoreInsn

toEnum :: Int -> XCoreInsn

fromEnum :: XCoreInsn -> Int

enumFrom :: XCoreInsn -> [XCoreInsn]

enumFromThen :: XCoreInsn -> XCoreInsn -> [XCoreInsn]

enumFromTo :: XCoreInsn -> XCoreInsn -> [XCoreInsn]

enumFromThenTo :: XCoreInsn -> XCoreInsn -> XCoreInsn -> [XCoreInsn]

Eq XCoreInsn

Methods

(==) :: XCoreInsn -> XCoreInsn -> Bool

(/=) :: XCoreInsn -> XCoreInsn -> Bool

Show XCoreInsn

Methods

showsPrec :: Int -> XCoreInsn -> ShowS

show :: XCoreInsn -> String

showList :: [XCoreInsn] -> ShowS

data XCoreInsnGroup

XCore instruction groups

Constructors

XcoreGrpInvalid

XcoreGrpJump

XcoreGrpEnding

Instances

Bounded XCoreInsnGroup

Methods

minBound :: XCoreInsnGroup

maxBound :: XCoreInsnGroup

Enum XCoreInsnGroup

Methods

succ :: XCoreInsnGroup -> XCoreInsnGroup

pred :: XCoreInsnGroup -> XCoreInsnGroup

toEnum :: Int -> XCoreInsnGroup

fromEnum :: XCoreInsnGroup -> Int

enumFrom :: XCoreInsnGroup -> [XCoreInsnGroup]

enumFromThen :: XCoreInsnGroup -> XCoreInsnGroup -> [XCoreInsnGroup]

enumFromTo :: XCoreInsnGroup -> XCoreInsnGroup -> [XCoreInsnGroup]

enumFromThenTo :: XCoreInsnGroup -> XCoreInsnGroup -> XCoreInsnGroup -> [XCoreInsnGroup]

Eq XCoreInsnGroup

Methods

(==) :: XCoreInsnGroup -> XCoreInsnGroup -> Bool

(/=) :: XCoreInsnGroup -> XCoreInsnGroup -> Bool

Show XCoreInsnGroup

Methods

showsPrec :: Int -> XCoreInsnGroup -> ShowS

show :: XCoreInsnGroup -> String

showList :: [XCoreInsnGroup] -> ShowS