Modify

Opened 6 years ago

Last modified 6 years ago

#10883 new enhancement

Debricking information per-firmware should be available off line

Reported by: jb-debbugs@… Owned by:
Priority: lowest Milestone: Features Paradise
Component: documentation Version: Trunk
Keywords: debrick failsafe Cc:

Description

When a router is (semi-)bricked, most users won't be able to
get online, so they can't read the debricking guides on the Wiki and forum.

Also, the [[doc:howto:generic.debrick]] page includes methods that won't work for all combinations of device and firmware. As each built firmware .bin is already specific to a hardware model, a good solution would be as follows:

  1. Each .bin is downloaded in a .zip file along with a generated text file detailing installation and debricking procedures for this specific device/firmware combo. ZIP files can be easily unpacked on just about any OS (unlike .tar.gz and modern formats).
  1. The text file is generated by concatenating selected text snippets with substitution of a few keyword placeholders for stuff such as model, port and button names.
  1. Each model has a C-preprocessed file that #defines the keywords and #includes the texts with appropriate #ifdef's for build variants. The build system can simply pull this through cpp and fold (using appropriate include path and define args to cpp) to generate the file.

A typical doc template file might go:

#define MODEL DIR-825-Bx
#define FAILSAFEBUTTON WPS
#define BOOTLOAD_KEY RESET
#include "welcome.txt"
#include "welcome-dir-825.txt"
#include "known-issues.txt"
#include "known-issues-dir-825.txt"
#include "boot-flash-web.txt"
#include "boot-flash-dir-825-quirks.txt"
#include "debrick-intro.txt"
#ifdef SQUASH_FS_BUILD_OR_WHATEVER_THE_DEFINE_IS
#include "failsafe.txt"
#endif
#define SERIAL_LOCATION right side near the WPS button
#define SERIAL_NEEDS_SOLDER 1
#define SERIAL_VOLTS_3_3 1
#define SERIAL_PIN_GND ?
#define SERIAL_PIN_VCC ?
#define SERIAL_PIN_RX  ?
#define SERIAL_PIN_TX  ?
#define SERIAL_SPEED 115200
#include "debrick-serial.txt"
#define JTAG_LOCATION (sorry, not documented yet)
#include "debrick-jtag.txt"

Attachments (0)

Change History (1)

comment:1 Changed 6 years ago by jow

  • Milestone changed from Attitude Adjustment (trunk) to Features Paradise
  • Priority changed from normal to lowest
  • Version changed from 10.03.1 to Trunk

File -> Save As -> Webpage (complete)

Add Comment

Modify Ticket

Action
as new .
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.