@mainpage README.md

# ICS SFP RESOURCES RELEASE NOTES
> Copyright (c) 2023 Intrepid Control Systems, Inc.


---

## General Information

### ICS SFP Resources include latest Release firmware and VSpy .vs3 files for module interfacing, and includes the following:
- sfp_mv2221m_b1_mchip.msgbin
  - Latest Release Firmware for SFP-MV2221M module
- sfp_mv2112_a2_mchip.msgbin
  - Latest Release Firmware for SFP-MV2112 module
- RGS_ICS_SFP_FLASHER_REV1_4.vs3
  - VSpy .vs3 for flashing ICS SFP module firmware
- ICS_SFP_MV2221M_TC10.vs3
  - VSpy .vs3 for interfacing examples with ICS SFP modules via I2C
- /MACsec/
  - Python src files for loading a MACsec configuration to the device

### Instructions:
- ICS SFP Firmware Flashing:
  - Copy "sfp_mv2221m_b1_mchip.msgbin" and "sfp_mv2112_a2_mchip.msgbin" to directory "<VSPY_INSTALL_DIR>\Data Directory\Default"
  - Run VSpy
  - Load "RGS_ICS_SFP_FLASHER_REV1_4.vs3"
  - Go online with RADGigastar
  - Make sure an SFP module is plugged into a RADGigastar SFP port
  - Click the "Flash Firmware" button on the displayed Graphical Panel
  - Wait for indicater "Flashing Completed"
  - Limitations:
    - This .vs3 only supports flashing 1 SFP port at a time (RADGigastar SFP1 port is prioritized)
    - May need to plug cycle the device after successful flashing for the RADgigastar to detect the module
- ICS SFP module interfacing examples:
  - Run VSpy
  - Load "ICS_SFP_MV2221M_TC10.vs3"
  - Go online with RADGigastar
  - Make sure an ICS SFP module is plugged into a RADGigstar SFP port
  - Transmit I2C messages for Read/Write examples
  - NOTES
    - I2C2 messages correlate with SFP1 port on the RADgigastar
    - I2C3 messages correlate with SFP2 port on the RADgigastar
    - All TC10 example messages are only supported on the SFP-MV2221M module (PHY limitation)
- MACsec
  - See "/MACsec/README.md"
---

## Version History
- (11/27/2023)
  - Added "MACsec" folder with python src files for loading a MACsec configuration to the device
    - /yaml/ folder containing 8 MACsec configurations
    - test_sfp_macsec_util.py
    - util_eth.py
    - util_sfp.py
    - util.py
    - README.md
- (9/5/2023)
  - Fix ICS SFP flasher textbox and led indicaters:
    - RGS_ICS_SFP_FLASHER_REV1_4.vs3
- (9/5/2023)
  - Fix ICS SFP flasher binary size errors:
    - RGS_ICS_SFP_FLASHER_REV1_3.vs3
- (8/9/2023)
  - Update Release firwmare:
    - sfp_mv2221m_b1_mchip.msgbin
    - sfp_mv2112_a2_mchip.msgbin
- (6/29/2023)
  - First draft of the following files:
    - sfp_mv2221m_b1_mchip.msgbin
    - sfp_mv2112_a2_mchip.msgbin
    - ICS_SFP_FLASHER.vs3
    - ICS_SFP_MV2221M_TC10.vs3

---
