Sojus07/hackrf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #981 from straithe/updateDocsHackRFPage

Browse Source 
Update HackRF one docs page
This commit is contained in:
Michael Ossmann
2021-11-03 15:01:49 -06:00
committed by GitHub
parent f92d49ab23 5a56fff91a
commit 681d0c165b
5 changed files with 268 additions and 272 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/enclosure_options.rst Normal file
View File

@ -0,0 +1,8 @@
Enclosure Options
~~~~~~~~~~~~~~~~~
The commercial version of HackRF One from Great Scott Gadgets ships with an injection molded plastic enclosure, but it is designed to fit two optional enclosures:
* Hammond 1455J1201: HackRF One fits this extruded aluminum enclosure and other similar models from Hammond Manufacturing. In order to use the enclosure's end plates, you will have to drill them. An end plate template can be found in the HackRF One KiCad layout.
* Acrylic sandwich: You can also use a laser cut acrylic enclosure with HackRF One. This is a good option for access to the expansion headers. A design can be found in the HackRF One hardware directory. Use any laser cutting service or purchase from a `reseller <http://greatscottgadgets.com/acrylic_case/>`__.

236
docs/source/expansion_interface.rst Normal file
View File

@ -0,0 +1,236 @@
Expansion Interface
~~~~~~~~~~~~~~~~~~~
The HackRF One expansion interface consists of headers P9, P20, P22, and P28. These four headers are installed on the commercial HackRF One from Great Scott Gadgets.
P9 Baseband
^^^^^^^^^^^
A direct analog interface to the high speed dual ADC and dual DAC.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- GND
* - 2
- GND
* - 3
- GND
* - 4
- RXBBQ-
* - 5
- RXBBI-
* - 6
- RXBBQ+
* - 7
- RXBBI+
* - 8
- GND
* - 9
- GND
* - 10
- TXBBI-
* - 11
- TXBBQ+
* - 12
- TXBBI+
* - 13
- TXBBQ-
* - 14
- GND
* - 15
- GND
* - 16
- GND
P20 GPIO
^^^^^^^^
Providing access to GPIO, ADC, RTC, and power.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- VBAT
* - 2
- RTC_ALARM
* - 3
- VCC
* - 4
- WAKEUP
* - 5
- GPIO3_8
* - 6
- GPIO3_0
* - 7
- GPIO3_10
* - 8
- GPIO3_11
* - 9
- GPIO3_12
* - 10
- GPIO3_13
* - 11
- GPIO3_14
* - 12
- GPIO3_15
* - 13
- GND
* - 14
- ADC0_6
* - 15
- GND
* - 16
- ADC0_2
* - 17
- VBUSCTRL
* - 18
- ADC0_5
* - 19
- GND
* - 20
- ADC0_0
* - 21
- VBUS
* - 22
- VIN
P22 I2S
^^^^^^^
I2S, SPI, I2C, UART, GPIO, and clocks.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- CLKOUT
* - 2
- CLKIN
* - 3
- RESET
* - 4
- GND
* - 5
- I2C1_SCL
* - 6
- I2C1_SDA
* - 7
- SPIFI_MISO
* - 8
- SPIFI_SCK
* - 9
- SPIFI_MOSI
* - 10
- GND
* - 11
- VCC
* - 12
- I2S0_RX_SCK
* - 13
- I2S_RX_SDA
* - 14
- I2S0_RX_MCLK
* - 15
- I2S0_RX_WS
* - 16
- I2S0_TX_SCK
* - 17
- I2S0_TX_MCLK
* - 18
- GND
* - 19
- U0_RXD
* - 20
- U0_TXD
* - 21
- P2_9
* - 22
- P2_13
* - 23
- P2_8
* - 24
- SDA
* - 25
- CLK6
* - 26
- SCL
P28 SD
^^^^^^
SDIO, GPIO, clocks, and CPLD.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- VCC
* - 2
- GND
* - 3
- SD_CD
* - 4
- SD_DAT3
* - 5
- SD_DAT2
* - 6
- SD_DAT1
* - 7
- SD_DAT0
* - 8
- SD_VOLT0
* - 9
- SD_CMD
* - 10
- SD_POW
* - 11
- SD_CLK
* - 12
- GND
* - 13
- GCK2
* - 14
- GCK1
* - 15
- B1AUX14
* - 16
- B1AUX13
* - 17
- CPLD_TCK
* - 18
- BANK2F3M2
* - 19
- CPLD_TDI
* - 20
- BANK2F3M6
* - 21
- BANK2F3M12
* - 22
- BANK2F3M4
Additional unpopulated headers and test points are available for test and development, but they may be incompatible with some enclosure or expansion options.
Refer to the schematics and component documentation for more information.

271
docs/source/hackrf_one.rst
View File

@ -25,38 +25,6 @@ Features
Differences between Jawbreaker and HackRF One
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Jawbreaker was the beta platform that preceded HackRF One. HackRF One incorporates the following changes and enhancements:
* Antenna port: No modification is necessary to use the SMA antenna port on HackRF One.
* PCB antenna: Removed.
* Size: HackRF One is smaller at 120 mm x 75 mm (PCB size).
* Enclosure: The commercial version of HackRF One from Great Scott Gadgets ships with an injection molded plastic enclosure. HackRF One is also designed to fit other enclosure options.
* Buttons: HackRF One has a RESET button and a DFU button for easy programming.
* Clock input and output: Installed and functional without modification.
* USB connector: HackRF One features a new USB connector and improved USB layout.
* Expansion interface: More pins are available for expansion, and pin headers are installed on HackRF One.
* Real-Time Clock: An RTC is installed on HackRF One.
* LPC4320 microcontroller: Jawbreaker had an LPC4330.
* RF shield footprint: An optional shield may be installed over HackRF One's RF section.
* Antenna port power: HackRF One can supply up to 50 mA at 3.3 V DC on the antenna port for compatibility with powered antennas and other low power amplifiers.
* Enhanced frequency range: The RF performance of HackRF One is better than Jawbreaker, particularly at the high and low ends of the operating frequency range. HackRF One can operate at 1 MHz or even lower.
Enclosure Options
~~~~~~~~~~~~~~~~~
The commercial version of HackRF One from Great Scott Gadgets ships with an injection molded plastic enclosure, but it is designed to fit two optional enclosures:
* Hammond 1455J1201: HackRF One fits this extruded aluminum enclosure and other similar models from Hammond Manufacturing. In order to use the enclosure's end plates, you will have to drill them. An end plate template can be found in the HackRF One KiCad layout.
* Acrylic sandwich: You can also use a laser cut acrylic enclosure with HackRF One. This is a good option for access to the expansion headers. A design can be found in the HackRF One hardware directory. Use any laser cutting service or purchase from a `reseller <http://greatscottgadgets.com/acrylic_case/>`__.
Using HackRF One's Buttons
~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -122,242 +90,3 @@ Hardware Documentation
~~~~~~~~~~~~~~~~~~~~~~
Schematic diagram, assembly diagram,and bill of materials can be found at `https://github.com/mossmann/hackrf/tree/master/doc/hardware <https://github.com/mossmann/hackrf/tree/master/doc/hardware>`__
Expansion Interface
~~~~~~~~~~~~~~~~~~~
The HackRF One expansion interface consists of headers P9, P20, P22, and P28. These four headers are installed on the commercial HackRF One from Great Scott Gadgets.
P9 Baseband
^^^^^^^^^^^
A direct analog interface to the high speed dual ADC and dual DAC.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- GND
* - 2
- GND
* - 3
- GND
* - 4
- RXBBQ-
* - 5
- RXBBI-
* - 6
- RXBBQ+
* - 7
- RXBBI+
* - 8
- GND
* - 9
- GND
* - 10
- TXBBI-
* - 11
- TXBBQ+
* - 12
- TXBBI+
* - 13
- TXBBQ-
* - 14
- GND
* - 15
- GND
* - 16
- GND
P20 GPIO
^^^^^^^^
Providing access to GPIO, ADC, RTC, and power.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- VBAT
* - 2
- RTC_ALARM
* - 3
- VCC
* - 4
- WAKEUP
* - 5
- GPIO3_8
* - 6
- GPIO3_0
* - 7
- GPIO3_10
* - 8
- GPIO3_11
* - 9
- GPIO3_12
* - 10
- GPIO3_13
* - 11
- GPIO3_14
* - 12
- GPIO3_15
* - 13
- GND
* - 14
- ADC0_6
* - 15
- GND
* - 16
- ADC0_2
* - 17
- VBUSCTRL
* - 18
- ADC0_5
* - 19
- GND
* - 20
- ADC0_0
* - 21
- VBUS
* - 22
- VIN
P22 I2S
^^^^^^^
I2S, SPI, I2C, UART, GPIO, and clocks.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- CLKOUT
* - 2
- CLKIN
* - 3
- RESET
* - 4
- GND
* - 5
- I2C1_SCL
* - 6
- I2C1_SDA
* - 7
- SPIFI_MISO
* - 8
- SPIFI_SCK
* - 9
- SPIFI_MOSI
* - 10
- GND
* - 11
- VCC
* - 12
- I2S0_RX_SCK
* - 13
- I2S_RX_SDA
* - 14
- I2S0_RX_MCLK
* - 15
- I2S0_RX_WS
* - 16
- I2S0_TX_SCK
* - 17
- I2S0_TX_MCLK
* - 18
- GND
* - 19
- U0_RXD
* - 20
- U0_TXD
* - 21
- P2_9
* - 22
- P2_13
* - 23
- P2_8
* - 24
- SDA
* - 25
- CLK6
* - 26
- SCL
P28 SD
^^^^^^
SDIO, GPIO, clocks, and CPLD.
.. list-table ::
:header-rows: 1
:widths: 1 1
* - Pin
- Function
* - 1
- VCC
* - 2
- GND
* - 3
- SD_CD
* - 4
- SD_DAT3
* - 5
- SD_DAT2
* - 6
- SD_DAT1
* - 7
- SD_DAT0
* - 8
- SD_VOLT0
* - 9
- SD_CMD
* - 10
- SD_POW
* - 11
- SD_CLK
* - 12
- GND
* - 13
- GCK2
* - 14
- GCK1
* - 15
- B1AUX14
* - 16
- B1AUX13
* - 17
- CPLD_TCK
* - 18
- BANK2F3M2
* - 19
- CPLD_TDI
* - 20
- BANK2F3M6
* - 21
- BANK2F3M12
* - 22
- BANK2F3M4
Additional unpopulated headers and test points are available for test and development, but they may be incompatible with some enclosure or expansion options.
Refer to the schematics and component documentation for more information.

2
docs/source/index.rst
View File

@ -40,6 +40,8 @@ Welcome to HackRF's documentation!
hardware_components
clocking
enclosure_options
expansion_interface
multiple_device_hardware_synch
.. toctree::

23
docs/source/jawbreaker.rst
View File

@ -536,4 +536,25 @@ Cut P17 short (trace) to enable external clock input. If short is cut, a jumper
More
^^^^
Additional headers are available. See the `board files <https://github.com/mossmann/hackrf/tree/master/hardware/jawbreaker>`__ for additional details.
Additional headers are available. See the `board files <https://github.com/mossmann/hackrf/tree/master/hardware/jawbreaker>`__ for additional details.
Differences between Jawbreaker and HackRF One
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Jawbreaker was the beta platform that preceded HackRF One. HackRF One incorporates the following changes and enhancements:
* Antenna port: No modification is necessary to use the SMA antenna port on HackRF One.
* PCB antenna: Removed.
* Size: HackRF One is smaller at 120 mm x 75 mm (PCB size).
* Enclosure: The commercial version of HackRF One from Great Scott Gadgets ships with an injection molded plastic enclosure. HackRF One is also designed to fit other enclosure options.
* Buttons: HackRF One has a RESET button and a DFU button for easy programming.
* Clock input and output: Installed and functional without modification.
* USB connector: HackRF One features a new USB connector and improved USB layout.
* Expansion interface: More pins are available for expansion, and pin headers are installed on HackRF One.
* Real-Time Clock: An RTC is installed on HackRF One.
* LPC4320 microcontroller: Jawbreaker had an LPC4330.
* RF shield footprint: An optional shield may be installed over HackRF One's RF section.
* Antenna port power: HackRF One can supply up to 50 mA at 3.3 V DC on the antenna port for compatibility with powered antennas and other low power amplifiers.
* Enhanced frequency range: The RF performance of HackRF One is better than Jawbreaker, particularly at the high and low ends of the operating frequency range. HackRF One can operate at 1 MHz or even lower.