Hung-Wei Chiu | 77c969e | 2020-10-23 18:13:07 +0000 | [diff] [blame] | 1 | .. |
| 2 | SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org> |
| 3 | SPDX-License-Identifier: Apache-2.0 |
| 4 | |
Hung-Wei Chiu | 77c969e | 2020-10-23 18:13:07 +0000 | [diff] [blame] | 5 | eNB Installation |
| 6 | ================ |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 7 | |
| 8 | This section describes how to install and configure the Sercomm eNB which is |
| 9 | the default eNB device in Aether. |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 10 | |
Woojoong Kim | 6bfbf8a | 2020-11-25 15:32:15 -0800 | [diff] [blame] | 11 | .. _enb-installation: |
| 12 | |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 13 | Preliminaries |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 14 | ------------- |
| 15 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 16 | Prepare the following devices: |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 17 | |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 18 | * Sercomm eNB |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 19 | * GPS Antenna |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 20 | * 10GbE SFP+ to 1/10GbE copper media converter |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 21 | * PoE+ Injector |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 22 | * Workstation to remotely access and configure the eNB |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 23 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 24 | Collect the following information: |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 25 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 26 | * eNB IP address |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 27 | * MME IP address (10.168.0.6 by default for Aether Central) |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 28 | * TAC |
| 29 | * Cell ID |
| 30 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 31 | .. warning:: |
Charles Chan | eec8a26 | 2021-10-21 15:58:27 -0700 | [diff] [blame] | 32 | ``Cell ID`` and ``TAC`` are critical parameters that need to be globally unique. |
| 33 | Please get the assigned value from OPs team. |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 34 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 35 | Connect the eNB |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 36 | --------------- |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 37 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 38 | The Sercomm eNB has two Ethernet ports (``WAN`` and ``LAN``), one power port, |
| 39 | and one GPS port. The ``WAN`` port support Power over Ethernet (PoE+). |
| 40 | |
| 41 | Connect a GPS Antenna to the eNB and place is in a location where it has |
| 42 | visibility to the open sky, such as a window or skylight. |
| 43 | |
| 44 | Connect the eNB to the fabric switch through a media converter and PoE+ |
| 45 | Injector to the ``WAN`` port of the eNB, then it will automatically get |
| 46 | pre-configured IP address using DHCP. |
| 47 | |
| 48 | Verify that you can access the web-based configuration(``https://<eNB IP>``) |
| 49 | from your workstation. If the eNB address is not directly reachable, use the |
| 50 | management server as a jump host - this can be done using ssh:: |
| 51 | |
| 52 | ssh user@jumphost -L 8443:<eNB IP>:443 |
| 53 | |
| 54 | then visiting ``https://localhost:8443`` |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 55 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 56 | The default credentials for the Sercomm eNB are: |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 57 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 58 | * Username: ``sc_femto`` |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 59 | * Password: ``scHt3pp`` (may also be ``sc_femto``) |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 60 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 61 | .. image:: images/enb-sercomm-home.png |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 62 | |
Hyunsun Moon | 8de7fa7 | 2021-10-25 16:00:11 -0700 | [diff] [blame^] | 63 | Upgrade Firmware |
| 64 | ---------------- |
| 65 | |
| 66 | Download the latest firmware to your workstation. |
| 67 | |
| 68 | From the eNB configuration page, |
| 69 | go to **Manage > Firmware Management**, click **Choose File** button, select the downloaded firmware, |
| 70 | and click **Upload** button. Reboot the eNB if it does not automatically. |
| 71 | |
| 72 | .. image:: images/enb-sercomm-firmware-upgrade.png |
| 73 | |
| 74 | After the reboot, confirm the ``Software version`` from the **State > State** menu. |
| 75 | |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 76 | LTE configuration |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 77 | ----------------- |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 78 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 79 | Go to **Manage > LTE Basic Settings** tab and change the parameters as shown below. |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 80 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 81 | Click ``Save`` at the bottom after making the changes. |
| 82 | |
| 83 | .. image:: images/enb-sercomm-lte.png |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 84 | :alt: Sercomm eNB UI LTE configuration page |
| 85 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 86 | * Carrier Number: ``2`` |
| 87 | * Carrier Aggregation: ``unchecked`` |
| 88 | * BandWidth: ``20`` |
| 89 | * FrequencyBand: ``48,48`` |
| 90 | * EARFCN: ``55440,55640`` |
| 91 | * CellIdentity: ``assigned Cell ID`` |
| 92 | * PCI: ``100,101`` |
| 93 | * TxPower: ``20`` |
| 94 | * Tunnel Type: ``IPv4`` |
| 95 | * MME IP Address: ``10.168.0.6`` |
| 96 | * TAC: ``assigned TAC`` |
| 97 | * PLMNID: ``315010`` |
| 98 | * Sync Source: ``FREE_RUNNING`` |
| 99 | * Enable CWMP: ``unchecked`` |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 100 | |
Charles Chan | eec8a26 | 2021-10-21 15:58:27 -0700 | [diff] [blame] | 101 | .. note:: |
| 102 | E-UTRAN Cell Global Identifier (ECGI) should be used for the `CellIdentity` field |
| 103 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 104 | Other Settings |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 105 | -------------- |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 106 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 107 | Go to **TR098 > SysPara** tab and set ``fsminitd`` parameter setting to ``2``. |
| 108 | Click ``Modify`` button right next to the parameter value, and ``Save`` button at the bottom. |
| 109 | |
| 110 | .. image:: images/enb-sercomm-syspara.png |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 111 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 112 | Connect the Sercomm eNB to the Google SAS |
| 113 | ----------------------------------------- |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 114 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 115 | Configure the SAS parameters by going to the **Manage > SAS Configuration** |
| 116 | tab. Configure the following parameters: |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 117 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 118 | * Enable: checked |
| 119 | * Server URL: ``https://sas.goog/v1.2/`` |
| 120 | * UserContactInformation: ``aether`` |
| 121 | * FCCID: ``P27-SCE4255W`` (It can be find on the device) |
| 122 | * Category: ``A`` |
| 123 | * Measure Configuration: ``RECEIVED_POWER_WITHOUT_GRANT`` |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 124 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 125 | .. image:: images/enb-sercomm-sascfg.png |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 126 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 127 | Make a note of the eNB's GPS coordinates, as they are used later |
| 128 | |
| 129 | .. note:: |
| 130 | The Sercomm eNB multiplies the GPS coordinates by 1000000, and the height in |
| 131 | meters by 1000 in it's UI. |
| 132 | |
| 133 | Next, go to the **FAP > FAP_Security** section. This will list security |
| 134 | certificates installed on the eNB, and will provide both the device Serial |
| 135 | Number and the certificate subject. On the first line copy the ``Subject`` |
| 136 | field, which should have content similar to ``/C=TW/O=Sercomm/OU=WInnForum CBSD |
| 137 | Certificate/CN=P27-SCE4255W:2009CW5000019``. |
| 138 | |
| 139 | .. image:: images/enb-sercomm-fapsec.png |
| 140 | |
| 141 | For the SAS to trust the CBSD, it must receive signed CPI data specific to the |
| 142 | device. To create this data, duplicate the ``example.json`` as |
| 143 | ``DEVICE_SERIAL_NUMBER.json``, and update the content to match eNB's settings. |
| 144 | |
| 145 | The signing tool `cbrstools/cpisign.py |
| 146 | <https://gerrit.opencord.org/plugins/gitiles/cbrstools/+/refs/heads/master/cpisign.py>`_ |
| 147 | script will sign CPI data. |
| 148 | |
| 149 | This script requires a CBRS CPI key (``.p12`` format) and associated password |
| 150 | to be run - an example invocation:: |
| 151 | |
| 152 | $ python cpisign.py -k YOUR_CPI_KEY.p12 DEVICE_SERIAL_NUMBER.json |
| 153 | |
| 154 | It will prompt for your CPI key password when run, and will generate a signed |
| 155 | file in ``output/`` folder, named with the serial number. |
| 156 | |
| 157 | Next, go to the **FAPService > FAPControl** tab , and in the |
| 158 | **FAPService_FAPControl_LTE** section set these fields: |
| 159 | |
| 160 | * AdminState: checked |
| 161 | |
| 162 | In the **FAPService_FAPControl_LTE_X_000E8F_SAS** section, configure the |
| 163 | following information in fields: |
| 164 | |
| 165 | * CPIEnable: checked |
| 166 | * Enable: checked |
| 167 | * ManufacturerPrefixEnable: checked |
| 168 | * Server: <should have the SAS URL filled in> |
| 169 | * CPIId: <CPI_ID_from_certificate> |
| 170 | * CPIName: <CPI_name> |
| 171 | * HeightType: ``AGL`` |
| 172 | * CPISignatureData: <generated_output_from_python_script> |
| 173 | * Location: ``indoor`` |
| 174 | * AntennaAzimuth, AntennaDowntilt, AntennaGain, AntennaBeamwidth: same as |
| 175 | SERIAL_NUMBER.json |
| 176 | |
| 177 | * CertSubject: ``/C=TW/O=Sercomm/OU=WInnForum CBSD |
| 178 | Certificate/CN=P27-SCE4255W:2009CW50000...`` (from previous step) |
| 179 | |
| 180 | Then click ``Save``, and go to the power icon at top right and tell the eNB to restart. |
| 181 | |
| 182 | Once restarted, check the **State > Misc State** tab to verify that the device |
| 183 | is registered with SAS. |
| 184 | |
| 185 | .. image:: images/enb-sercomm-sasstatus.png |
| 186 | |
| 187 | Verify that the eNB is correctly registered on the SAS website. |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 188 | |
| 189 | Troubleshooting |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 190 | --------------- |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 191 | |
| 192 | Connectivity check |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 193 | """""""""""""""""" |
| 194 | |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 195 | In order to check the connectivity, we can use the Sercomm eNB admin UI. |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 196 | |
| 197 | Go to **Manage > IP Diagnose** tab |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 198 | |
Hyunsun Moon | cd0d42f | 2021-10-18 19:08:41 -0700 | [diff] [blame] | 199 | .. image:: images/enb-sercomm-ip-diagnose.png |
Woojoong Kim | 6348401 | 2020-11-11 17:20:55 -0800 | [diff] [blame] | 200 | :alt: Sercomm eNB UI IP Diagnose page |
| 201 | |
Wei-Yu Chen | 91d90de | 2021-10-18 22:06:12 +0800 | [diff] [blame] | 202 | In this page, check the ``ping`` menu, put an IP address to test in the text |
| 203 | box, and click ``Run`` button. |
| 204 | |
| 205 | After a few seconds the ping results will be displayed. |
| 206 | |
| 207 | eNB SAS log shows failed state |
| 208 | """""""""""""""""""""""""""""" |
| 209 | |
| 210 | Usually this is because of a configuration mismatch between the eNB config and |
| 211 | CPI signature data. Check in **Manage > Log > sas.log** and look for |
| 212 | information returned by the SAS. |
| 213 | |
| 214 | eNB SAS log disappears |
| 215 | """""""""""""""""""""" |
| 216 | |
| 217 | When the eNB runs out of space due to log messages, the sas daemon will not |
| 218 | run. Clear the log by clicking ``ClearLog`` at the bottom of the log page. |
| 219 | |
| 220 | eNB SAS log shows errors |
| 221 | """""""""""""""""""""""" |
| 222 | |
| 223 | If the sas.log shows a message like ``failed to open file |
| 224 | /var/conf/sas/cpi.key`` there is likely something wrong with the configuration. |
| 225 | Check the following: |
| 226 | |
| 227 | * ``CPISignatureData`` field - data is larger than the field size, could be |
| 228 | entered twice. |
| 229 | |
| 230 | * Check that the location and other data that is signed by the CPI key matches |
| 231 | the data in the eNB UI. |