diff --git a/guides/contributor.rst b/guides/contributor.rst index 7f6dcb7271880a48db8060e717069eb12cdb2089..b6699e75e67876c73248dc935ea4aae3767feb7e 100644 --- a/guides/contributor.rst +++ b/guides/contributor.rst @@ -7,6 +7,12 @@ Contributor Guide :width: 100% :align: center +.. admonition:: What is the mission? + + We don't want to just make more things. We want to enable individuals to make the things that dominate their lives, + rather than leaving it up to someone else. Google Summer of a Code with BeagleBoard.org is a great way to learn + skills highly in demand while making a difference in the world. + General requirements ******************** diff --git a/guides/index.rst b/guides/index.rst index fef9612c9d85186cfe13047d1c0e3d1e587ae12b..9892c280411a40cde96ee12813f4a49fa196fe43 100644 --- a/guides/index.rst +++ b/guides/index.rst @@ -8,6 +8,11 @@ in GSoC 2024 with `BeagleBoard.org <www.beagleboard.org>`_. It's highly recommen <https://developers.google.com/open-source/gsoc/faq>`_. For anyone who just want to contribute to this site we also have a step by step :ref:`contribution guide <gsoc-site-editing-guide>`. +.. admonition:: Did you know? + + BeagleBoard.org has been accepted to be a mentoring organization in the + Google Summer of Code (GSoC) for twelve previous years! + .. card:: :link: gsoc-contributor-guide :link-type: ref diff --git a/guides/proposal.rst b/guides/proposal.rst index 3aff3238713ea454fb1c85bb96d9bacfadce777f..418819ab3f6530604863a7576addbddb87d0c83b 100644 --- a/guides/proposal.rst +++ b/guides/proposal.rst @@ -65,9 +65,8 @@ You can either open your cloned `gsoc.beagleboard.io repo <https://openbeagle.or .. raw:: html - <br> - <a class="btn btn-danger btn-sm btn-block text-light" role="button" href="/proposals/template.pdf"> - <i class="fa-solid fa-download"></i> template.pdf + <a role="button" href=""> + <i class="fa-solid fa-download"></i> Download PDF </a> diff --git a/ideas/index.rst b/ideas/index.rst index 4fb9fffaee4237764f71f9b3310dfd334e153a5a..e29892944577e6b349e99ac92c9fd171cc60aa91 100644 --- a/ideas/index.rst +++ b/ideas/index.rst @@ -5,19 +5,16 @@ Ideas ###### -.. sidebar:: Welcome +Welcome to the project ideas page for `GSoC 2024 <https://developers.google.com/open-source/gsoc/timeline>`_. The +BeagleBoard.org community is loaded with experts on building open source embedded systems. An embedded +system is built using a computer dedicated to a specific purpose, like a toaster, coffee machine, dish washer, thermostat +or anti-lock brakes. You can think of an embedded system as a computer designed to not look like a computer +and to automate things in the physical world. - Welcome to the project ideas page for `GSoC 2024 <https://developers.google.com/open-source/gsoc/timeline>`_. The - BeagleBoard.org community is loaded with experts on building open source embedded systems. An embedded - system is built using a computer dedicated to a specific purpose, like a toaster, coffee machine, dish washer, thermostat - or anti-lock brakes. You can think of an embedded system as a computer designed to not look like a computer - and to automate things in the physical world. +.. image:: ../_static/images/ideas-below.webp + :align: center -.. sidebar:: Did you know? - - BeagleBoard.org has been accepted to be a mentoring organization in the Google Summer of Code (GSoC) for twelve previous years! - -.. sidebar:: How to participate? +.. admonition:: How to participate? Contributors are expected to go through the list of ideas below and join the discussion by clicking on the ``Discuss on forum`` button. All ideas have colorful badges for ``Complexity`` and @@ -26,140 +23,97 @@ Ideas Only ideas with sufficiently experienced mentor backing as deemed by the administrators will be added here. - .. table:: - - +------------------------------------+-------------------------------+ - | Complexity | Size | - +====================================+===============================+ - | :bdg-danger:`High complexity` | :bdg-danger-line:`350 hours` | - +------------------------------------+-------------------------------+ - | :bdg-success:`Medium complexity` | :bdg-success-line:`175 hours` | - +------------------------------------+-------------------------------+ - | :bdg-info:`Low complexity` | :bdg-info-line:`90 hours` | - +------------------------------------+-------------------------------+ - -.. sidebar:: Looking for more? - - Please visit `our forum <https://forum.beagleboard.org/t/gsoc-ideas>`_ to see newer ideas being discussed! - - You can also check our our :ref:`gsoc-old-ideas` and :ref:`Past_Projects` for inspiration. - -.. sidebar:: What is the mission? - - We don't want to just make more things. We want to enable individuals to make the things that dominate their lives, - rather than leaving it up to someone else. Google Summer of a Code with BeagleBoard.org is a great way to learn - skills highly in demand while making a difference in the world. - -.. grid:: 1 1 1 1 - :margin: 4 4 0 0 - :gutter: 1 - - .. grid-item:: + +------------------------------------+-------------------------------+ + | Complexity | Size | + +====================================+===============================+ + | :bdg-danger:`High complexity` | :bdg-danger-line:`350 hours` | + +------------------------------------+-------------------------------+ + | :bdg-success:`Medium complexity` | :bdg-success-line:`175 hours` | + +------------------------------------+-------------------------------+ + | :bdg-info:`Low complexity` | :bdg-info-line:`90 hours` | + +------------------------------------+-------------------------------+ - .. image:: ../_static/images/ideas-below.webp - :align: center +.. dropdown:: Low-latency I/O RISC-V CPU core in FPGA fabric - .. grid-item-card:: + BeagleV-Fire features RISC-V 64-bit CPU cores and FPGA fabric. In that FPGA fabric, we'd like to + implement a RISC-V 32-bit CPU core with operations optimized for low-latency GPIO. This is similar + to the programmable real-time unit (PRU) RISC cores popularized on BeagleBone Black. - :fas:`exclamation;pst-color-danger` Important: **No direct messages** - ^^^ + | **Goal:** RISC-V-based CPU on BeagleV-Fire FPGA fabric with GPIO + | **Hardware Skills:** Verilog, Verification, FPGA + | **Software Skills:** RISC-V ISA, assembly, `Linux`_ + | **Possible Mentors:** `Cyril Jean <https://forum.beagleboard.org/u/vauban>`_, `Jason Kridner <https://forum.beagleboard.org/u/jkridner>`_ + | + | :fas:`microchip;pst-color-primary` FPGA gateware improvements :bdg-success:`Medium complexity` :bdg-success-line:`175 hours` - BeagleBoard.org is all about being open. Please keep discussion in public - on `our forum <https://bbb.io/gsocml>`_. + .. button-link:: https://forum.beagleboard.org/t/low-latency-risc-v-i-o-cpu-core/37156 + :color: danger + :expand: - .. grid-item-card:: Low-latency I/O RISC-V CPU core in FPGA fabric + :fab:`discourse;pst-color-light` Discuss on forum - | :fas:`microchip;pst-color-primary` FPGA gateware improvements - | :bdg-success:`Medium complexity` :bdg-success-line:`175 hours` - ^^^ - BeagleV-Fire features RISC-V 64-bit CPU cores and FPGA fabric. In that FPGA fabric, we'd like to - implement a RISC-V 32-bit CPU core with operations optimized for low-latency GPIO. This is similar - to the programmable real-time unit (PRU) RISC cores popularized on BeagleBone Black. +.. dropdown:: Update beagle-tester for mainline testing - | **Goal:** RISC-V-based CPU on BeagleV-Fire FPGA fabric with GPIO - | **Hardware Skills:** Verilog, Verification, FPGA - | **Software Skills:** RISC-V ISA, assembly, `Linux`_ - | **Possible Mentors:** `Cyril Jean <https://forum.beagleboard.org/u/vauban>`_, `Jason Kridner <https://forum.beagleboard.org/u/jkridner>`_ + Utilize the ``beagle-tester`` application and ``Buildroot`` along with device-tree and udev symlink concepts within + the OpenBeagle continuous integration server context to create a regression test suite for the Linux kernel + and device-tree overlays on various Beagle computers. - +++ - .. button-link:: https://forum.beagleboard.org/t/low-latency-risc-v-i-o-cpu-core/37156 - :color: danger - :expand: + | **Goal:** Execution on Beagle test farm with over 30 mikroBUS boards testing all mikroBUS enabled cape interfaces (PWM, ADC, UART, I2C, SPI, GPIO and interrupt) performing weekly mainline Linux regression verification + | **Hardware Skills:** basic wiring, familiarity with embedded serial interfaces + | **Software Skills:** device-tree, `Linux`_, `C`_, continuous integration with GitLab, Buildroot + | **Possible Mentors:** `Deepak Khatri <https://forum.beagleboard.org/u/lorforlinux>`_, `Anuj Deshpande <https://forum.beagleboard.org/u/Anuj_Deshpande>`_, `Dhruva Gole <https://forum.beagleboard.org/u/dhruvag2000>`_ + | + | :fab:`linux;pst-color-primary` Linux kernel improvements :bdg-success:`Medium complexity` :bdg-danger-line:`350 hours` - :fab:`discourse;pst-color-light` Discuss on forum + .. button-link:: https://forum.beagleboard.org/t/update-beagle-tester-for-cape-mikrobus-new-board-and-upstream-testing/37279 + :color: danger + :expand: + :fab:`discourse;pst-color-light` Discuss on forum - .. grid-item-card:: Update beagle-tester for mainline testing +.. dropdown:: Upstream wpanusb and bcfserial - | :fab:`linux;pst-color-primary` Linux kernel improvements - | :bdg-success:`Medium complexity` :bdg-danger-line:`350 hours` - ^^^ + These are the drivers that are used to enable Linux to use a BeagleConnect Freedom as a SubGHz IEEE802.15.4 radio (gateway). + They need to be part of upstream Linux to simplify on-going support. There are several gaps that are known before they are + acceptable upstream. - Utilize the ``beagle-tester`` application and ``Buildroot`` along with device-tree and udev symlink concepts within - the OpenBeagle continuous integration server context to create a regression test suite for the Linux kernel - and device-tree overlays on various Beagle computers. + | **Goal:** Add functional gaps, submit upstream patches for these drivers and respond to feedback + | **Hardware Skills:** Familiarity with wireless communication + | **Software Skills:** `C`_, `Linux`_ + | **Possible Mentors:** `Ayush Singh <https://forum.beagleboard.org/u/ayush1325>`_, `Jason Kridner <https://forum.beagleboard.org/u/jkridner>`_ + | + | :fab:`linux;pst-color-primary` Linux kernel improvements :bdg-success:`Medium complexity` :bdg-success-line:`175 hours` - | **Goal:** Execution on Beagle test farm with over 30 mikroBUS boards testing all mikroBUS enabled cape interfaces (PWM, ADC, UART, I2C, SPI, GPIO and interrupt) performing weekly mainline Linux regression verification - | **Hardware Skills:** basic wiring, familiarity with embedded serial interfaces - | **Software Skills:** device-tree, `Linux`_, `C`_, continuous integration with GitLab, Buildroot - | **Possible Mentors:** `Deepak Khatri <https://forum.beagleboard.org/u/lorforlinux>`_, `Anuj Deshpande <https://forum.beagleboard.org/u/Anuj_Deshpande>`_, `Dhruva Gole <https://forum.beagleboard.org/u/dhruvag2000>`_ + .. button-link:: https://forum.beagleboard.org/t/upstream-wpanusb-and-bcfserial/37186 + :color: danger + :expand: - +++ - .. button-link:: https://forum.beagleboard.org/t/update-beagle-tester-for-cape-mikrobus-new-board-and-upstream-testing/37279 - :color: danger - :expand: + :fab:`discourse;pst-color-light` Discuss on forum - :fab:`discourse;pst-color-light` Discuss on forum +.. dropdown:: ``librobotcontrol`` support for newer boards - .. grid-item-card:: Upstream wpanusb and bcfserial + Preliminary librobotcontrol support for BeagleBone AI, BeagleBone AI-64 and BeagleV-Fire has been drafted, but it + needs to be cleaned up. We can also work on support for Raspberry Pi if UCSD releases their Hat for it. - | :fab:`linux;pst-color-primary` Linux kernel improvements - | :bdg-success:`Medium complexity` :bdg-success-line:`175 hours` - ^^^ + | **Goal:** Update librobotcontrol for Robotics Cape on BeagleBone AI, BeagleBone AI-64 and BeagleV-Fire + | **Hardware Skills:** Basic wiring, some DC motor familiarity + | **Software Skills:** `C`_, `Linux`_ + | **Possible Mentors:** `Deepak Khatri <https://forum.beagleboard.org/u/lorforlinux>`_, `Jason Kridner <https://forum.beagleboard.org/u/jkridner>`_ + | + | :fas:`wand-sparkles;pst-color-danger` Automation and industrial I/O :bdg-success:`Medium complexity` :bdg-success-line:`175 hours` + + .. button-link:: https://forum.beagleboard.org/t/librobotcontrol-support-for-newer-boards/37187 + :color: danger + :expand: - These are the drivers that are used to enable Linux to use a BeagleConnect Freedom as a SubGHz IEEE802.15.4 radio (gateway). - They need to be part of upstream Linux to simplify on-going support. There are several gaps that are known before they are - acceptable upstream. + :fab:`discourse;pst-color-light` Discuss on forum - | **Goal:** Add functional gaps, submit upstream patches for these drivers and respond to feedback - | **Hardware Skills:** Familiarity with wireless communication - | **Software Skills:** `C`_, `Linux`_ - | **Possible Mentors:** `Ayush Singh <https://forum.beagleboard.org/u/ayush1325>`_, `Jason Kridner <https://forum.beagleboard.org/u/jkridner>`_ +.. tip:: - +++ - .. button-link:: https://forum.beagleboard.org/t/upstream-wpanusb-and-bcfserial/37186 - :color: danger - :expand: - - :fab:`discourse;pst-color-light` Discuss on forum - - .. grid-item-card:: ``librobotcontrol`` support for newer boards - - | :fas:`wand-sparkles;pst-color-danger` Automation and industrial I/O - | :bdg-success:`Medium complexity` :bdg-success-line:`175 hours` - ^^^ - - Preliminary librobotcontrol support for BeagleBone AI, BeagleBone AI-64 and BeagleV-Fire has been drafted, but it - needs to be cleaned up. We can also work on support for Raspberry Pi if UCSD releases their Hat for it. - - | **Goal:** Update librobotcontrol for Robotics Cape on BeagleBone AI, BeagleBone AI-64 and BeagleV-Fire - | **Hardware Skills:** Basic wiring, some DC motor familiarity - | **Software Skills:** `C`_, `Linux`_ - | **Possible Mentors:** `Deepak Khatri <https://forum.beagleboard.org/u/lorforlinux>`_, `Jason Kridner <https://forum.beagleboard.org/u/jkridner>`_ - - +++ - .. button-link:: https://forum.beagleboard.org/t/librobotcontrol-support-for-newer-boards/37187 - :color: danger - :expand: - - :fab:`discourse;pst-color-light` Discuss on forum - -.. button-link:: https://forum.beagleboard.org/tag/gsoc-ideas - :color: light - :expand: - - :fab:`discourse;pst-color-light` Visit our forum for more ideas + Visit `our forum <https://forum.beagleboard.org/t/gsoc-ideas>`_ to see newer ideas being discussed! + + You can also check our our :ref:`gsoc-old-ideas` and :ref:`Past_Projects` for inspiration. .. _Linux: https://docs.beagleboard.org/latest/intro/beagle101/linux.html