-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
efed306
commit 33cd0ed
Showing
36 changed files
with
2,541 additions
and
701 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [ | ||
| { | ||
| "top": "vexRiscvTest", | ||
| "stage": "test", | ||
| "targets": "Specific [-1]" | ||
| } | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| -- SPDX-FileCopyrightText: 2024 Google LLC | ||
| -- | ||
| -- SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| {-# LANGUAGE NumericUnderscores #-} | ||
| {-# LANGUAGE RecordWildCards #-} | ||
|
|
||
| -- | Logic for extracting memory maps from circuits in this project. | ||
| -- This is a separate module from MemoryMaps because of GHC's stage restrictions | ||
| -- around TemplateHaskell. | ||
| module Bittide.Instances.MemoryMapLogic where | ||
|
|
||
| import Clash.Prelude | ||
|
|
||
| import Control.Monad (forM_) | ||
|
|
||
| import Protocols.MemoryMap ( annotationSnd, MemoryMap ) | ||
| import Bittide.Instances.Hitl.VexRiscv (cpuCircuit) | ||
| import Protocols.MemoryMap.Check (CheckConfiguration(..), check, MemoryMapValidationErrors(..), shortLocation, prettyPrintPath) | ||
| import Project.FilePath (findParentContaining, buildDir) | ||
| import System.FilePath | ||
| import Language.Haskell.TH (runIO, reportError, Q) | ||
| import System.Directory (createDirectoryIfMissing) | ||
| import Protocols.MemoryMap.Check.Overlap (OverlapError(..)) | ||
| import Protocols.MemoryMap.Check.AbsAddress (AbsAddressValidateError(..)) | ||
|
|
||
| import qualified Data.List as L | ||
| import qualified Data.ByteString.Lazy as BS | ||
| import Protocols.MemoryMap.Json (memoryMapJson) | ||
| import Data.Aeson (encode) | ||
| import Text.Printf (printf) | ||
|
|
||
| data MemMapProcessing = MemMapProcessing | ||
| { name :: String | ||
| , memMap :: MemoryMap | ||
| , checkConfig :: CheckConfiguration | ||
| , jsonOutput :: Maybe FilePath | ||
| } | ||
|
|
||
| defaultCheckConfig :: CheckConfiguration | ||
| defaultCheckConfig = CheckConfiguration | ||
| { startAddr = 0x0000_0000 | ||
| , endAddr = 0xFFFF_FFFF | ||
| } | ||
|
|
||
| unSimOnly :: SimOnly a -> a | ||
| unSimOnly (SimOnly x) = x | ||
|
|
||
| memMaps :: [MemMapProcessing] | ||
| memMaps = | ||
| [ MemMapProcessing | ||
| { name = "VexRiscv" | ||
| , memMap = unSimOnly $ annotationSnd @System cpuCircuit | ||
| , checkConfig = defaultCheckConfig | ||
| , jsonOutput = Just "vexriscv.json" | ||
| } | ||
| ] | ||
|
|
||
| processMemoryMaps :: Q () | ||
| processMemoryMaps = do | ||
| memMapDir <- runIO $ do | ||
| root <- findParentContaining "cabal.project" | ||
| let dir = root </> buildDir </> "memory_maps" | ||
| createDirectoryIfMissing True dir | ||
| pure dir | ||
|
|
||
|
|
||
| forM_ memMaps $ \(MemMapProcessing{..}) -> do | ||
| case check checkConfig memMap of | ||
| Left MemoryMapValidationErrors{..} -> do | ||
| let absErrorMsgs = flip L.map absAddrErrors $ \AbsAddressValidateError{..} -> | ||
| let path' = prettyPrintPath path | ||
| component = case componentName of | ||
| Just name' -> name' | ||
| Nothing -> "interconnect " <> path' | ||
| in | ||
| printf "Expected component %s at %08X but found %08X (%s)" component expected got (shortLocation location) | ||
|
|
||
| let overlapErrorMsgs = flip L.map overlapErrors $ \case | ||
| OverlapError{..} -> | ||
| printf "Component %s (%08X + %08X) overlaps with %s at address (%08X) (%s)" | ||
| (prettyPrintPath path) startAddr componentSize | ||
| (prettyPrintPath overlapsWith) overlapsAt | ||
| (shortLocation location) | ||
| SizeExceedsError{..} -> | ||
| printf "Component %s (%08X + %08X) exceeds available size %08X (%s)" | ||
| (prettyPrintPath path) startAddr requestedSize | ||
| availableSize | ||
| (shortLocation location) | ||
| reportError (unlines $ absErrorMsgs <> overlapErrorMsgs) | ||
|
|
||
| Right checkedMemMap -> do | ||
| case jsonOutput of | ||
| Nothing -> pure () | ||
| Just path -> do | ||
| let json = memoryMapJson checkedMemMap | ||
| runIO $ BS.writeFile (memMapDir </> path) (encode json) | ||
| pure () | ||
| pure () |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| -- SPDX-FileCopyrightText: 2024 Google LLC | ||
| -- | ||
| -- SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| {-# LANGUAGE NumericUnderscores #-} | ||
| {-# LANGUAGE RecordWildCards #-} | ||
| module Bittide.Instances.MemoryMaps where | ||
|
|
||
| import Clash.Prelude | ||
|
|
||
| import Bittide.Instances.MemoryMapLogic (processMemoryMaps) | ||
|
|
||
| $(do | ||
| processMemoryMaps | ||
| pure []) |
Oops, something went wrong.