Copyright	(c) David Cox 2024
License	BSD-3-Clause
Maintainer	standardsemiconductor@gmail.com
Safe Haskell	None
Language	Haskell2010

Lion.Core

Description

The Lion core is a 32-bit RISC-V processor written in Haskell using Clash. Note, all peripherals and memory must have single cycle latency. See lion-soc for an example of using the Lion core in a system.

Synopsis

core :: HiddenClockResetEnable dom => CoreConfig -> Signal dom (BitVector 32) -> FromCore dom
defaultCoreConfig :: CoreConfig
defaultPipeConfig :: PipeConfig
data CoreConfig = CoreConfig {
- aluConfig :: AluConfig
- pipeConfig :: PipeConfig
}
data AluConfig
- = Hard
- | Soft
newtype PipeConfig = PipeConfig {
- startPC :: BitVector 32
}
data FromCore dom = FromCore {
- toMem :: Signal dom (Maybe ToMem)
- toRvfi :: Signal dom Rvfi
}
data ToMem = ToMem {
- memAccess :: MemoryAccess
- memAddress :: BitVector 32
- memByteMask :: BitVector 4
- memWrite :: Maybe (BitVector 32)
}
data MemoryAccess
- = InstrMem
- | DataMem

Documentation

core Source #

Arguments

:: HiddenClockResetEnable dom
=> CoreConfig	core configuration
-> Signal dom (BitVector 32)	core input, from memory/peripherals
-> FromCore dom	core output

RISC-V Core: RV32I

defaultCoreConfig :: CoreConfig Source #

Default core configuration

aluConfig = Soft

pipeConfig = defaultPipeConfig

defaultPipeConfig :: PipeConfig Source #

Default pipeline configuration

startPC = 0

data CoreConfig Source #

Core configuration

Constructors

CoreConfig
Fields aluConfig :: AluConfig ALU configuration, default: `Soft` pipeConfig :: PipeConfig pipeline configuration

Instances

Instances details

Eq CoreConfig Source #
Instance details Defined in Lion.Core Methods (==) :: CoreConfig -> CoreConfig -> Bool Source # (/=) :: CoreConfig -> CoreConfig -> Bool Source #
Show CoreConfig Source #
Instance details Defined in Lion.Core Methods showsPrec :: Int -> CoreConfig -> ShowS Source # show :: CoreConfig -> String Source # showList :: [CoreConfig] -> ShowS Source #
Generic CoreConfig Source #
Instance details Defined in Lion.Core Associated Types type Rep CoreConfig :: Type -> Type Source # Methods from :: CoreConfig -> Rep CoreConfig x Source # to :: Rep CoreConfig x -> CoreConfig Source #
type Rep CoreConfig Source #
Instance details Defined in Lion.Core type Rep CoreConfig = D1 ('MetaData "CoreConfig" "Lion.Core" "lion-0.4.0.0-inplace" 'False) (C1 ('MetaCons "CoreConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "aluConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AluConfig) :*: S1 ('MetaSel ('Just "pipeConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PipeConfig)))

data AluConfig Source #

ALU configuration

Constructors

Hard	use hard adder and subtractor from iCE40 SB_MAC16
Soft	use generic adder and subtractor: (+) and (-)

Instances

Instances details

Eq AluConfig Source #
Instance details Defined in Lion.Alu Methods (==) :: AluConfig -> AluConfig -> Bool Source # (/=) :: AluConfig -> AluConfig -> Bool Source #
Show AluConfig Source #
Instance details Defined in Lion.Alu Methods showsPrec :: Int -> AluConfig -> ShowS Source # show :: AluConfig -> String Source # showList :: [AluConfig] -> ShowS Source #
Generic AluConfig Source #
Instance details Defined in Lion.Alu Associated Types type Rep AluConfig :: Type -> Type Source # Methods from :: AluConfig -> Rep AluConfig x Source # to :: Rep AluConfig x -> AluConfig Source #
type Rep AluConfig Source #
Instance details Defined in Lion.Alu type Rep AluConfig = D1 ('MetaData "AluConfig" "Lion.Alu" "lion-0.4.0.0-inplace" 'False) (C1 ('MetaCons "Hard" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Soft" 'PrefixI 'False) (U1 :: Type -> Type))

newtype PipeConfig Source #

Pipeline configuration

Constructors

PipeConfig
Fields startPC :: BitVector 32 start program counter

Instances

Instances details

Eq PipeConfig Source #
Instance details Defined in Lion.Pipe Methods (==) :: PipeConfig -> PipeConfig -> Bool Source # (/=) :: PipeConfig -> PipeConfig -> Bool Source #
Show PipeConfig Source #
Instance details Defined in Lion.Pipe Methods showsPrec :: Int -> PipeConfig -> ShowS Source # show :: PipeConfig -> String Source # showList :: [PipeConfig] -> ShowS Source #
Generic PipeConfig Source #
Instance details Defined in Lion.Pipe Associated Types type Rep PipeConfig :: Type -> Type Source # Methods from :: PipeConfig -> Rep PipeConfig x Source # to :: Rep PipeConfig x -> PipeConfig Source #
type Rep PipeConfig Source #
Instance details Defined in Lion.Pipe type Rep PipeConfig = D1 ('MetaData "PipeConfig" "Lion.Pipe" "lion-0.4.0.0-inplace" 'True) (C1 ('MetaCons "PipeConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "startPC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (BitVector 32))))

data FromCore dom Source #

Core outputs

Constructors

FromCore
Fields toMem :: Signal dom (Maybe ToMem) shared memory and instruction bus, output from core to memory and peripherals toRvfi :: Signal dom Rvfi formal verification interface output, see lion-formal for usage

data ToMem Source #

Memory bus

Constructors

ToMem
Fields memAccess :: MemoryAccess memory access type memAddress :: BitVector 32 memory address memByteMask :: BitVector 4 memory byte mask memWrite :: Maybe (BitVector 32) read=Nothing write=Just wr

Instances

Instances details

Eq ToMem Source #
Instance details Defined in Lion.Pipe Methods (==) :: ToMem -> ToMem -> Bool Source # (/=) :: ToMem -> ToMem -> Bool Source #
Show ToMem Source #
Instance details Defined in Lion.Pipe Methods showsPrec :: Int -> ToMem -> ShowS Source # show :: ToMem -> String Source # showList :: [ToMem] -> ShowS Source #
Generic ToMem Source #
Instance details Defined in Lion.Pipe Associated Types type Rep ToMem :: Type -> Type Source # Methods from :: ToMem -> Rep ToMem x Source # to :: Rep ToMem x -> ToMem Source #
NFDataX ToMem Source #
Instance details Defined in Lion.Pipe Methods deepErrorX :: String -> ToMem Source # hasUndefined :: ToMem -> Bool Source # ensureSpine :: ToMem -> ToMem Source # rnfX :: ToMem -> () Source #
type Rep ToMem Source #
Instance details Defined in Lion.Pipe type Rep ToMem = D1 ('MetaData "ToMem" "Lion.Pipe" "lion-0.4.0.0-inplace" 'False) (C1 ('MetaCons "ToMem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "memAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MemoryAccess) :: S1 ('MetaSel ('Just "memAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (BitVector 32))) :: (S1 ('MetaSel ('Just "memByteMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (BitVector 4)) :*: S1 ('MetaSel ('Just "memWrite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (BitVector 32))))))

data MemoryAccess Source #

Memory access - Lion has a shared instruction/memory bus

Constructors

InstrMem	instruction access
DataMem	data access

Instances

Instances details

Eq MemoryAccess Source #
Instance details Defined in Lion.Pipe Methods (==) :: MemoryAccess -> MemoryAccess -> Bool Source # (/=) :: MemoryAccess -> MemoryAccess -> Bool Source #
Show MemoryAccess Source #
Instance details Defined in Lion.Pipe Methods showsPrec :: Int -> MemoryAccess -> ShowS Source # show :: MemoryAccess -> String Source # showList :: [MemoryAccess] -> ShowS Source #
Generic MemoryAccess Source #
Instance details Defined in Lion.Pipe Associated Types type Rep MemoryAccess :: Type -> Type Source # Methods from :: MemoryAccess -> Rep MemoryAccess x Source # to :: Rep MemoryAccess x -> MemoryAccess Source #
NFDataX MemoryAccess Source #
Instance details Defined in Lion.Pipe Methods deepErrorX :: String -> MemoryAccess Source # hasUndefined :: MemoryAccess -> Bool Source # ensureSpine :: MemoryAccess -> MemoryAccess Source # rnfX :: MemoryAccess -> () Source #
type Rep MemoryAccess Source #
Instance details Defined in Lion.Pipe type Rep MemoryAccess = D1 ('MetaData "MemoryAccess" "Lion.Pipe" "lion-0.4.0.0-inplace" 'False) (C1 ('MetaCons "InstrMem" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DataMem" 'PrefixI 'False) (U1 :: Type -> Type))