README.md
<![CDATA[]]><![CDATA[]]>

SFP Doctor

SFP Doctor is an open source hardware & software project for reading and writing the EEPROM inside SFP & SFP+ modules.

About

SFP modules contain an EEPROM which contains information about the module.  This information includes the OUI (Organizationally Unique Identifier) which identifies the vendor of the module.

Some NIC's and switches are locked to using a particular vendors own SFP modules, this hardware and software project provides a tool for reading and modifying this information (providing the vendor has not disabled write access to the EEPROM).

The hardware design is intended to be as simple and cheap as possible, therefore it makes use of the <![CDATA[]]>Cypress CYC8CKIT-059<![CDATA[]]> prototyping board as the USB interface to the EEPROM on the module, this board is readily and cheaply available.

Repository Contents


/hardware - <![CDATA[]]>KiCad<![CDATA[]]> schematic and PCB layout source files.
/firmware - The firmware for the <![CDATA[]]>CY8C5888LTI-LP097<![CDATA[]]> microcontroller on the <![CDATA[]]>Cypress CYC8CKIT-059<![CDATA[]]> prototyping board.
/software - The desktop software to control the hardware.
/drivers - Platform dependent drivers for the hardware interface.


Required Tools


<![CDATA[]]>Cypress PSoC Creator<![CDATA[]]> for firmware development.
<![CDATA[]]>KiCad<![CDATA[]]> for hardware design.
<![CDATA[]]>Node.js<![CDATA[]]> for desktop software.
<![CDATA[]]>Yarn<![CDATA[]]> for desktop software.
<![CDATA[]]>ELECTRON<![CDATA[]]> for desktop software development.


Building Software

Desktop

After installing the prequestite packages, use the following commands.

yarn run build
yarn run start


The platform binary can be created with the following commands.

yarn run build
yarn run dist


(Please note that currently the software is not functional)

Firmware

Open the firmware project in PSOC Creator and select build to create the firmware image.

Project Status

Hardware


Design: Complete.
Manufacture: In progress.


06-Nov-2019 - PCB's arrived, build & test commenced.



Firmware


Development: Started.


Software


Development: Started.


With Thanks

This project is using a USB VID & PID kindly allocated by <![CDATA[]]>pid.codes<![CDATA[]]>.  Their repository can be found <![CDATA[]]>here<![CDATA[]]>.  They support open source development by providing VID/PID pairs for free.

License

This project is open source and the entire project is released under the <![CDATA[]]>GPLv3 license<![CDATA[]]>.

Distributed as-is; no warranty is given.