Lion.Core

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.

Documentation

core

Arguments

:: forall a startPC dom. HiddenClockResetEnable dom

=> Alu a

=> (KnownNat startPC, startPC <= 4294967295)

=> CoreConfig (startPC :: Nat) (a :: AluConfig)

core configuration

-> Signal dom (BitVector 32)

core input, from memory/peripherals

-> FromCore dom

core output

RISC-V Core: RV32I

defaultCoreConfig :: CoreConfig 0 'Soft

Default core configuration

ALU configuration = Soft

pipeConfig = defaultPipeConfig

defaultPipeConfig :: PipeConfig 0

Default pipeline configuration

startPC = 0

newtype CoreConfig (startPC :: Nat) (a :: AluConfig)

Core configuration

ALU configuration default: Soft

Constructors

CoreConfig

Fields

• pipeConfig :: PipeConfig (startPC :: Nat)

  pipeline configuration

Instances

Eq (CoreConfig startPC a)

Defined in Lion.Core

Methods

(==) :: CoreConfig startPC a -> CoreConfig startPC a -> Bool

(/=) :: CoreConfig startPC a -> CoreConfig startPC a -> Bool

Show (CoreConfig startPC a)

Defined in Lion.Core

Methods

showsPrec :: Int -> CoreConfig startPC a -> ShowS

show :: CoreConfig startPC a -> String

showList :: [CoreConfig startPC a] -> ShowS

Generic (CoreConfig startPC a)

Defined in Lion.Core

Associated Types

type Rep (CoreConfig startPC a) :: Type -> Type

Methods

from :: CoreConfig startPC a -> Rep (CoreConfig startPC a) x

to :: Rep (CoreConfig startPC a) x -> CoreConfig startPC a

type Rep (CoreConfig startPC a)

Defined in Lion.Core

type Rep (CoreConfig startPC a) = D1 ('MetaData "CoreConfig" "Lion.Core" "lion-0.3.0.0-5TeZzf2f4nX8XqM2dA3bRI" 'True) (C1 ('MetaCons "CoreConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipeConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PipeConfig startPC))))

data AluConfig

ALU configuration

Constructors

Hard

use hard adder and subtractor from iCE40 SB_MAC16

Soft

use generic adder and subtractor: (+) and (-)

Instances

Eq AluConfig

Defined in Lion.Alu

Methods

(==) :: AluConfig -> AluConfig -> Bool

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

Show AluConfig

Defined in Lion.Alu

Methods

showsPrec :: Int -> AluConfig -> ShowS

show :: AluConfig -> String

showList :: [AluConfig] -> ShowS

Generic AluConfig

Defined in Lion.Alu

Associated Types

type Rep AluConfig :: Type -> Type

Methods

from :: AluConfig -> Rep AluConfig x

to :: Rep AluConfig x -> AluConfig

type Rep AluConfig

Defined in Lion.Alu

type Rep AluConfig = D1 ('MetaData "AluConfig" "Lion.Alu" "lion-0.3.0.0-5TeZzf2f4nX8XqM2dA3bRI" 'False) (C1 ('MetaCons "Hard" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Soft" 'PrefixI 'False) (U1 :: Type -> Type))

data PipeConfig (startPC :: Nat)

Pipeline configuration

Constructors

PipeConfig

Instances

Eq (PipeConfig startPC)

Defined in Lion.Pipe

Methods

(==) :: PipeConfig startPC -> PipeConfig startPC -> Bool

(/=) :: PipeConfig startPC -> PipeConfig startPC -> Bool

Show (PipeConfig startPC)

Defined in Lion.Pipe

Methods

showsPrec :: Int -> PipeConfig startPC -> ShowS

show :: PipeConfig startPC -> String

showList :: [PipeConfig startPC] -> ShowS

Generic (PipeConfig startPC)

Defined in Lion.Pipe

Associated Types

type Rep (PipeConfig startPC) :: Type -> Type

Methods

from :: PipeConfig startPC -> Rep (PipeConfig startPC) x

to :: Rep (PipeConfig startPC) x -> PipeConfig startPC

type Rep (PipeConfig startPC)

Defined in Lion.Pipe

type Rep (PipeConfig startPC) = D1 ('MetaData "PipeConfig" "Lion.Pipe" "lion-0.3.0.0-5TeZzf2f4nX8XqM2dA3bRI" 'False) (C1 ('MetaCons "PipeConfig" 'PrefixI 'False) (U1 :: Type -> Type))

data FromCore dom

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

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

Eq ToMem

Defined in Lion.Pipe

Methods

(==) :: ToMem -> ToMem -> Bool

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

Show ToMem

Defined in Lion.Pipe

Methods

showsPrec :: Int -> ToMem -> ShowS

show :: ToMem -> String

showList :: [ToMem] -> ShowS

Generic ToMem

Defined in Lion.Pipe

Associated Types

type Rep ToMem :: Type -> Type

Methods

from :: ToMem -> Rep ToMem x

to :: Rep ToMem x -> ToMem

NFDataX ToMem

Defined in Lion.Pipe

Methods

deepErrorX :: String -> ToMem

hasUndefined :: ToMem -> Bool

ensureSpine :: ToMem -> ToMem

rnfX :: ToMem -> ()

type Rep ToMem

Defined in Lion.Pipe

type Rep ToMem = D1 ('MetaData "ToMem" "Lion.Pipe" "lion-0.3.0.0-5TeZzf2f4nX8XqM2dA3bRI" '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

Memory access - Lion has a shared instruction/memory bus

Constructors

InstrMem

instruction access

DataMem

data access

Instances

Eq MemoryAccess

Defined in Lion.Pipe

Methods

(==) :: MemoryAccess -> MemoryAccess -> Bool

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

Show MemoryAccess

Defined in Lion.Pipe

Methods

showsPrec :: Int -> MemoryAccess -> ShowS

show :: MemoryAccess -> String

showList :: [MemoryAccess] -> ShowS

Generic MemoryAccess

Defined in Lion.Pipe

Associated Types

type Rep MemoryAccess :: Type -> Type

Methods

from :: MemoryAccess -> Rep MemoryAccess x

to :: Rep MemoryAccess x -> MemoryAccess

NFDataX MemoryAccess

Defined in Lion.Pipe

Methods

deepErrorX :: String -> MemoryAccess

hasUndefined :: MemoryAccess -> Bool

ensureSpine :: MemoryAccess -> MemoryAccess

rnfX :: MemoryAccess -> ()

type Rep MemoryAccess

Defined in Lion.Pipe

type Rep MemoryAccess = D1 ('MetaData "MemoryAccess" "Lion.Pipe" "lion-0.3.0.0-5TeZzf2f4nX8XqM2dA3bRI" 'False) (C1 ('MetaCons "InstrMem" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DataMem" 'PrefixI 'False) (U1 :: Type -> Type))

class Alu (config :: AluConfig)

Minimal complete definition

alu

Instances

Alu 'Hard

Defined in Lion.Alu

Methods

alu :: forall (dom :: Domain). HiddenClockResetEnable dom => Proxy 'Hard -> Signal dom Op -> Signal dom (BitVector 32) -> Signal dom (BitVector 32) -> Signal dom (BitVector 32)

Alu 'Soft

Defined in Lion.Alu

Methods

alu :: forall (dom :: Domain). HiddenClockResetEnable dom => Proxy 'Soft -> Signal dom Op -> Signal dom (BitVector 32) -> Signal dom (BitVector 32) -> Signal dom (BitVector 32)