Skip to content

Buckyball documentation sync#3

Open
shirohasuki wants to merge 7 commits intomainfrom
cursor/buckyball-documentation-sync-8854
Open

Buckyball documentation sync#3
shirohasuki wants to merge 7 commits intomainfrom
cursor/buckyball-documentation-sync-8854

Conversation

@shirohasuki
Copy link
Member

Update Buckyball ISA encoding, add new GemminiBall instructions, and revise hardware design tutorial to reflect recent codebase changes.

Recent buckyball commits (e.g., 8bd6970 and 49b1ac1) introduced a significant change to the ISA funct7 encoding scheme and new GemminiBall loop instructions. This PR updates the documentation to align with these architectural shifts and provides a warning about the new Goban multi-core architecture.

Docs added or updated:

  • content/en/Overview/Buckyball ISA.md
  • content/zh/Overview/Buckyball ISA.md
  • content/en/Tutorial/Building Your Own Hardware Designs.md
  • content/zh/Tutorial/Building Your Own Hardware Designs.md

Buckyball codepaths or areas they cover:

  • Buckyball Instruction Set Architecture (ISA) encoding.
  • GemminiBall loop instructions.
  • Hardware design tutorial examples and architectural context (Goban multi-core).

Key knowledge gaps addressed:

  • Outdated funct7 encoding scheme in ISA tables and examples.
  • Missing documentation for new GemminiBall LOOP_WS and LOOP_CONV_WS instructions.
  • Lack of reference to the new Goban multi-core architecture in the hardware design tutorial.
Open in Web Open in Cursor 

cursoragent and others added 7 commits March 17, 2026 21:43
- Add GemminiBall Architecture guide: instruction routing, funct7 encoding, configuration and execution paths
- Add Verilator Simulation and CI guide: clock handling improvements, memory configuration, test execution
- Add Development Workflow and Build System guide: Nix setup, bbdev tool usage, common tasks
- Update .order.json to include new Guide section
- Sync both English and Chinese documentation

Co-authored-by: Shiroha <whmio0115@gmail.com>
… GemminiBall enhancements

- Add comprehensive Goban documentation (en and zh) covering:
  - Multi-core BBTile architecture and synchronization primitives
  - BarrierUnit hardware synchronization support
  - SPMD programming model with examples
  - Configuration variants (1-tile, 2-tile)
  - Test workloads (barrier tests)

- Update GemminiBall Architecture documentation (en and zh):
  - Document funct7 encoding with bank enable bits [6:4]
  - Add new instructions: IM2COL, TRANSPOSE, RELU, QUANT, DEQUANT, MATMUL_WARP16
  - Clarify loop configuration and execution paths
  - Reference recent loop unroller enhancements

Addresses missing Goban documentation reported in PR comments.

Co-authored-by: Shiroha <whmio0115@gmail.com>
…ion info

- Add Goban configuration options (BuckyballGobanVerilatorConfig, BuckyballGoban2TileVerilatorConfig)
- Include example Goban barrier test command
- Add reference link to Goban Multi-Core Architecture documentation
- Update both en and zh versions

Co-authored-by: Shiroha <whmio0115@gmail.com>
- Add Architecture & Key Concepts section in both en and zh Overview
- Document core components: Ball, Blink, BBTile, BarrierUnit
- Reference Toy and Goban configuration models
- Add Goban barrier test example to Quick Start
- Link to detailed architecture guides (ISA, GemminiBall, Goban)

Co-authored-by: Shiroha <whmio0115@gmail.com>
- Update funct7 encoding scheme from simple sequence to structured [6:4]=enable + [3:0]=opcode
- Revise instruction table with all new funct7 values (0, 1, 2, 3, 4, 16, 32-105)
- Add Gemmini loop instructions documentation (LOOP_WS and LOOP_CONV_WS)
- Add barrier instruction (bb_barrier)
- Update both zh and en locales in sync
- Add deprecation notice for legacy funct7 values in instruction details sections

Co-authored-by: Shiroha <whmio0115@gmail.com>
…ISA encoding

- Update funct7 example from 38 to 50 with new enable+opcode scheme
- Add note about ISA encoding specification update
- Add reference to new Goban multi-core architecture
- Clarify that tutorial uses single-core Toy configuration as example

Co-authored-by: Shiroha <whmio0115@gmail.com>
… latest ISA

- Update funct7 example from 38 to 50 with structured encoding scheme
- Add note about recent ISA specification update
- Reference Goban multi-core architecture documentation
- Maintain consistency with Chinese version

Co-authored-by: Shiroha <whmio0115@gmail.com>
@shirohasuki
Copy link
Member Author

Remove all notifications such as ‘Change notes’.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants