[New Plugin] Sysutils/vep1400-hw

sysutils/vep1400-hw/+POST_INSTALL

@@ -0,0 +1,4 @@
+/usr/local/etc/rc.syshook.d/early/50-vep1400-init
+/usr/local/etc/rc.syshook.d/start/99-vep1400-init-complete
+/usr/local/etc/rc.configure_plugins POST_INSTALL
+service configd restart

sysutils/vep1400-hw/Makefile

@@ -0,0 +1,8 @@
+PLUGIN_NAME=	        vep1400-hw	
+PLUGIN_VERSION=		1.1
+PLUGIN_REVISION=	1
+PLUGIN_COMMENT=	        Dell EMC VEP1400 initialization scripts 	
+PLUGIN_MAINTAINER=      brandontolbird@proton.me	
+PLUGIN_TIER=		2
+
+.include "../../Mk/plugins.mk"

sysutils/vep1400-hw/pkg-descr

@@ -0,0 +1,2 @@
+This includes a couple of rc.syshook scripts to handle setting up 
+the various interfaces and chips on a Dell VEP1400 board.

sysutils/vep1400-hw/src/etc/rc.syshook.d/early/50-vep1400-init

@@ -0,0 +1,60 @@
+#!/bin/sh
+
+#ichsmb has to load first, so that ismt is at /dev/smb1 (or adjust the script)
+needed_klds="ichsmb ismt smb"
+
+kldload $needed_klds &> /dev/null
+sleep 1
+
+ismt_dev=/dev/smb1
+
+board_id=$(smbmsg -f $ismt_dev -s 0x62 -c 0x00 -i 1 | cut -c 4-5)
+
+if [ ! -z $board_id ]; then
+
+    # Disable PIC Watch Dog
+    smbmsg -f $ismt_dev -s 0x44 -c 0 -o 1 0
+    # Set PIC Watch Dog default count to 0 (offset 0x0=LSB; 0x1=MSB)
+    smbmsg -f $ismt_dev -s 0x48 -c 0x0 -o 1 0x0
+    sleep 1
+    smbmsg -f $ismt_dev -s 0x48 -c 0x1 -o 1 0x0
+
+
+
+    if [ x"$board_id" = x"8" ] || [ x"$board_id" = x"a" ] || [ x"$board_id" = x"b" ]; then
+        logger -t "vep1400-hw" "VEP1400-X detected, doing init"
+        # VEP1400-X stuff
+        # fetch board type
+        # smbmsg -f $ismt_dev -s 0x62 -c 0x00 -i 1 | cut -c 4-5
+        # if 8, 10(a) or 11(b), do the following
+        # i2cset -y 1 0x31 0x1 0xff
+
+        #enable the i350 GbE ports
+        smbmsg -f $ismt_dev -s 0x62 -c 0x01 -o 1 0xff
+
+        # more VEP1400-x stuff
+        # Communicate with CPLD/FPGA to turn off SFP TX disable (DAC cables aren't affected by this)
+        # for ix1
+        smbmsg -f $ismt_dev -s 0x62 -c 0x10 -o 1 0x07
+        # for ix0
+        smbmsg -f $ismt_dev -s 0x62 -c 0x11 -o 1 0x07
+    fi
+
+    if [ x"$board_id" = x"0" ]; then
+        logger -t "vep1400-hw" "VEP1400 detected, doing init"
+        #Communicate with CPLD/FPGA to turn off SFP TX disable (DAC cables aren't affected by this)
+        # for ix3
+        smbmsg -f $ismt_dev -s 0x62 -c 0x10 -o 1 0
+        # for ix2
+        smbmsg -f $ismt_dev -s 0x62 -c 0x11 -o 1 0
+        if [ -e /dev/etherswitch0 ]; then
+            etherswitchcfg config vlan_mode dot1q
+            etherswitchcfg port1 pvid 2 port2 pvid 2 port3 pvid 2 port4 pvid 2 port5 pvid 2 port6 pvid 3 port9 pvid 3 port10 pvid 2 vlangroup0 vlan 2 members 1,2,3,4,5,10 vlangroup1 vlan 3 members 6,9
+            echo "Marvell 88E6190 configured. LAN ports are 1-5 and are connected to ix0. WAN is on port 6 and is connected to ix1."
+            logger -t "vep1400-hw" "Marvell 88E6190 configured. LAN is on ports 1-5 and is connected to ix0. WAN is on port 6 and is connected to ix1."
+        else
+            logger -t "vep1400-hw" "VEP1400 detected, but no etherswitch dev found. Is patched kernel installed?"
+        fi
+    fi
+fi
+

sysutils/vep1400-hw/src/etc/rc.syshook.d/start/99-vep1400-init-complete

@@ -0,0 +1,41 @@
+#!/bin/sh
+
+board_id=$(smbmsg -f /dev/smb1 -s 0x62 -c 0x00 -i 1 | cut -c 4-5)
+conf_file=/usr/local/etc/vep1400/vep1400.conf
+
+if [ -f $conf_file ]; then 
+    . $conf_file
+else
+    RED=0x00
+    GREEN=0xff
+    BLUE=0x00
+    FANCONTROL=0
+    FANDUTY=0
+fi
+
+if [ -z "$RED" ]; then
+    RED=0x00
+    GREEN=0xff
+    BLUE=0x00
+    FANCONTROL=0
+    FANDUTY=0
+fi
+
+if [ ! -z "$board_id" ]; then
+    # set front LED to green (or custom color if settings have been saved)
+    # format is -c (red) -o 2 (green) (blue) (some models lack a blue led)
+    smbmsg -f /dev/smb1 -s 0x40 -c $RED -o 2 $GREEN $BLUE
+
+    if [ x"$board_id" != x"0" ] && [ x"$board_id" != x"1" ]; then
+        # set fan speed. At address 36 is a TC654
+        # set control register to allow SMBus control of duty cycle
+        if [ "$FANCONTROL" == "0" ]; then
+            smbmsg -f $ismt_dev -s 0x36 -c 0x04 -o 1 0x14
+        elif [ "$FANCONTROL" == "1" ]; then
+            smbmsg -f $ismt_dev -s 0x36 -c 0x04 -o 1 0x34
+            # set duty cycle, range is 0x00 to 0x0f
+            # 0x0d is 90.67% duty cycle per datasheet
+            smbmsg -f $ismt_dev -s 0x36 -c 0x06 -o 1 $FANDUTY
+        fi
+    fi
+fi

sysutils/vep1400-hw/src/opnsense/mvc/app/controllers/OPNsense/vep1400hw/Api/InfoController.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * Copyright (C) 2023 Deciso B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace OPNsense\vep1400hw\Api;
+
+use OPNsense\Base\ApiControllerBase;
+use OPNsense\Core\Backend;
+
+class InfoController extends ApiControllerBase
+{
+    public function fanStatusAction()
+    {
+        $result = ["status" => "failed"];
+        $status = parse_ini_string((new Backend())->configdRun('vep1400hw getfan'));
+
+        if (!empty($status)) {
+            $result["status"] = "OK";
+            $result = array_merge($result, $status);
+        }
+
+        return $result;
+    }
+
+    public function tempStatusAction()
+    {
+        $result = ["status" => "failed"];
+        $status = trim((new Backend())->configdRun('vep1400hw gettemp'));
+
+        if (!empty($status)) {
+            $result["status"] = "OK";
+            $temp["temp"] = $status;
+            $result = array_merge($result, $temp);
+        }
+
+        return $result;
+    }
+
+    public function boardIdAction()
+    {
+        $result = ["status" => "failed"];
+        $status = trim((new Backend())->configdRun('vep1400hw getid'));
+
+        if (!empty($status)) {
+            $result["status"] = "OK";
+            $id["boardid"] = $status;
+            $result = array_merge($result, $id);
+        }
+
+        return $result;
+    }
+}

sysutils/vep1400-hw/src/opnsense/mvc/app/controllers/OPNsense/vep1400hw/Api/ServiceController.php

@@ -0,0 +1,84 @@
+<?php
+
+/**
+ *    Copyright (C) 2015 Deciso B.V.
+ *
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ *    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ *    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+namespace OPNsense\vep1400hw\Api;
+
+use OPNsense\Base\ApiMutableServiceControllerBase;
+use OPNsense\Core\Backend;
+
+
+class ServiceController extends ApiMutableServiceControllerBase
+{
+
+    protected static $internalServiceClass = '\OPNsense\vep1400hw\vep1400hw';
+    protected static $internalServiceTemplate = 'OPNsense/vep1400hw';
+    protected static $internalServiceEnabled = 'general.enabled';
+    protected static $internalServiceName = 'vep1400hw';
+
+
+    /**
+     * reconfigure vep1400hw
+     */
+    public function reloadAction()
+    {
+        $status = "failed";
+        if ($this->request->isPost()) {
+            $status = strtolower(trim((new Backend())->configdRun('template reload ' . self::$internalServiceTemplate)));
+        }
+        return ["status" => $status];
+    }//*/
+
+    /**
+     * apply
+     */
+    public function applyAction()
+    {
+        if ($this->request->isPost()) {
+            $mdl = $this->getModel();
+            $boardtype = trim((new Backend())->configdRun('vep1400hw getid'));
+            $boardnibble = substr($boardtype, -1);
+            if ($boardnibble != "0" && $boardnibble != "1"){
+                $fanc_enabled = $mdl->general->FanControl;
+                $fan_dc = $mdl->general->FanDutyCycle;
+                $fanresult = trim((new Backend())->configdRun(sprintf("vep1400hw setfan %s %s", $fanc_enabled, $fan_dc)));
+            }
+            else {
+                $fanresult = "OK"; //we can't set fan settings on boards without them so fake an OK
+            }
+            $ledr = $mdl->led->red; $ledg = $mdl->led->green; $ledb = $mdl->led->blue;
+            $ledresult = trim((new Backend())->configdRun(sprintf("vep1400hw setled %s %s %s", $ledr, $ledg, $ledb)));
+            if ($fanresult == "OK" && $ledresult == "OK") {
+                // only return valid json type responses
+                return ["message" => "Hardware settings applied successfully"];
+            }
+        }
+        return ["message" => "Hardware settings weren't applied."];
+    }
+}

sysutils/vep1400-hw/src/opnsense/mvc/app/controllers/OPNsense/vep1400hw/Api/SettingsController.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * Copyright (C) 2015-2019 Deciso B.V.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace OPNsense\vep1400hw\Api;
+
+use OPNsense\Base\ApiMutableModelControllerBase;
+
+/**
+ * Class SettingsController Handles settings related API actions for the VepHW module
+ * @package OPNsense\vep1400hw
+ */
+class SettingsController extends ApiMutableModelControllerBase
+{
+    protected static $internalModelClass = 'OPNsense\vep1400hw\vep1400hw';
+    protected static $internalModelName = 'vep1400hw';
+
+
+}

sysutils/vep1400-hw/src/opnsense/mvc/app/controllers/OPNsense/vep1400hw/IndexController.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ *    Copyright (C) 2015 Deciso B.V.
+ *
+ *    All rights reserved.
+ *
+ *    Redistribution and use in source and binary forms, with or without
+ *    modification, are permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice,
+ *       this list of conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *
+ *    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ *    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ *    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ *    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *    POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+namespace OPNsense\vep1400hw;
+
+/**
+ * Class IndexController
+ * @package OPNsense\VepHW
+ */
+class IndexController extends \OPNsense\Base\IndexController
+{
+    public function indexAction()
+    {
+        // pick the template to serve to our users.
+        $this->view->pick('OPNsense/vep1400hw/index');
+        // fetch form data "general" in
+        $this->view->generalForm = $this->getForm("general");
+    }
+}