Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

zStack 3.x.0 <-> zStack 3.0.x bidirectional migration #235

Merged
merged 12 commits into from
Oct 12, 2020
Merged

zStack 3.x.0 <-> zStack 3.0.x bidirectional migration #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
82680e8
Fix tests
hacker-cb Oct 8, 2020
74af668
Fix LEGACY_TCLK_TABLE_START 511 -> 273 (mistake during convert from hex)
hacker-cb Oct 8, 2020
c8e4cf7
Added ZCD_NV_TCLK_SEED to backup. Previously it was ZCD_NV_LEGACY_TCL…
hacker-cb Oct 8, 2020
1648d2c
Fix tests
hacker-cb Oct 8, 2020
56cab32
Fix ZCD_NV_EX_TCLK_TABLE and ZCD_NV_LEGACY_TCLK_TABLE_START tables in…
hacker-cb Oct 8, 2020
504bbbf
Added LEGACY_TCLK_TABLE_START_12 to avoid break on 1.2 Stack
hacker-cb Oct 8, 2020
d9e52bd
Remove TCLK_SEED from backup
hacker-cb Oct 9, 2020
d0fb63f
Added ZStack 3.0 <-> 3.1 migration
hacker-cb Oct 7, 2020
4a11b44
Added tests
hacker-cb Oct 9, 2020
3d116a5
Remove extra blank line
hacker-cb Oct 9, 2020
e9585fe
Added test to cover restore ZStack 1.2 error
hacker-cb Oct 12, 2020
a560eb1
Backup: Compare version inside backup, not only for current adapter
hacker-cb Oct 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 41 additions & 7 deletions src/adapter/z-stack/adapter/backup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {Subsystem} from '../unpi/constants';
import fs from 'fs';
import equals from 'fast-deep-equal/es6';
import Items from './nvItems';
import debug from "debug";

const {NvItemsIds, NvSystemIds, ZnpCommandStatus} = Constants.COMMON;

Expand Down Expand Up @@ -141,11 +142,43 @@ async function Restore(znp: Znp, backupPath: string, options: NetworkOptions): P
throw new Error(`Cannot restore backup, backup is for '${backup.adapterType}', current is 'zStack'`);
}

if (backup.meta.product != product) {
throw new Error(
`Cannot restore backup, backup is for '${ZnpVersion[backup.meta.product]}', ` +
`current is '${ZnpVersion[product]}'`
);
if ((product !== ZnpVersion.zStack30x && product !== ZnpVersion.zStack3x0)
|| (backup.meta.product !== ZnpVersion.zStack30x && backup.meta.product !== ZnpVersion.zStack3x0 )) {
throw new Error('Backup is only supported for Z-Stack 3');
}

// 3.0 3.x
// (0x0111)ZCD_NV_LEGACY_TCLK_TABLE_START -> (0x0004)ZCD_NV_EX_TCLK_TABLE
// (0x0075)ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START -> (0x0007)ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE
if (backup.meta.product == ZnpVersion.zStack30x && product == ZnpVersion.zStack3x0) {
debug(`Migrate '${ZnpVersion[backup.meta.product]}' -> '${ZnpVersion[product]}'`);

backup.data.ZCD_NV_EX_TCLK_TABLE = {
...items.ZCD_NV_EX_TCLK_TABLE,
value: backup.data.ZCD_NV_LEGACY_TCLK_TABLE_START.value,
len: backup.data.ZCD_NV_LEGACY_TCLK_TABLE_START.len,
};

backup.data.ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE = {
...items.ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE,
value: backup.data.ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START.value,
len: backup.data.ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START.len,
};

} else if (backup.meta.product == ZnpVersion.zStack3x0 && product == ZnpVersion.zStack30x) {
debug(`Migrate '${ZnpVersion[backup.meta.product]}' -> '${ZnpVersion[product]}'`);

backup.data.ZCD_NV_LEGACY_TCLK_TABLE_START = {
...items.ZCD_NV_LEGACY_TCLK_TABLE_START,
value: backup.data.ZCD_NV_EX_TCLK_TABLE.value,
len: backup.data.ZCD_NV_EX_TCLK_TABLE.len,
};

backup.data.ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START = {
...items.ZCD_NV_LEGACY_NWK_SEC_MATERIAL_TABLE_START,
value: backup.data.ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE.value,
len: backup.data.ZCD_NV_EX_NWK_SEC_MATERIAL_TABLE.len,
};
}

if (!equals(backup.data.ZCD_NV_CHANLIST.value, Constants.Utils.getChannelMask(options.channelList))) {
Expand Down Expand Up @@ -181,7 +214,8 @@ async function Restore(znp: Znp, backupPath: string, options: NetworkOptions): P

await znp.request(Subsystem.SYS, 'osalNvWrite', backup.data.ZCD_NV_EXTADDR);
await znp.request(Subsystem.SYS, 'osalNvItemInit', ZCD_NV_NIB, null,
[ZnpCommandStatus.NV_ITEM_INITIALIZED]);
[ZnpCommandStatus.SUCCESS, ZnpCommandStatus.NV_ITEM_INITIALIZED]);
await znp.request(Subsystem.SYS, 'osalNvWrite', backup.data.ZCD_NV_NIB);
await znp.request(Subsystem.SYS, 'osalNvWrite', backup.data.ZCD_NV_PANID);
await znp.request(Subsystem.SYS, 'osalNvWrite', backup.data.ZCD_NV_EXTENDED_PAN_ID);
await znp.request(Subsystem.SYS, 'osalNvWrite', backup.data.ZCD_NV_NWK_ACTIVE_KEY_INFO);
Expand All @@ -202,7 +236,7 @@ async function Restore(znp: Znp, backupPath: string, options: NetworkOptions): P
}

await znp.request(Subsystem.SYS, 'osalNvItemInit', Items.znpHasConfiguredInit(product), null,
[ZnpCommandStatus.NV_ITEM_INITIALIZED]);
[ZnpCommandStatus.SUCCESS, ZnpCommandStatus.NV_ITEM_INITIALIZED]);
await znp.request(Subsystem.SYS, 'osalNvWrite', Items.znpHasConfigured(product));
await znp.request(Subsystem.SYS, 'osalNvItemInit', bdbNodeIsOnANetwork, null,
[ZnpCommandStatus.SUCCESS, ZnpCommandStatus.NV_ITEM_INITIALIZED]);
Expand Down
Loading