A Better Shell

The product I'm helping to develop at work has a TCP service that you can telnet to and get a simple command-line shell for development purposes. In our firmware we have a simple framework for writing commands that can then be called from this shell. You can do all sorts of handy things like check sensors, run calibrations, query ASIC registers, read and write memory locations, and so forth. We also use this to play with different configurations and new features before making them permanent. The big downside to this shell is that, well, let's just say that for anyone used to a modern shell like bash, this one is stone-age. There is no command history, no command-line editing except to backspace and retype, and no scripting. This can get very frustrating when you have a command or set of commands that you need to run over and over. Especially when you start using fairly complicated ones with hexadecimal memory addresses, bit masks, and other esoteric parameters. Sure, somebody on our firmware team could add these features to our shell, but who has time for that (when we could be blogging instead, right?)?

I have been bringing up some new hardware for the past few weeks and using this shell heavily for that task. After the EEs I'm working with and I lamented for about the 100th time the lack of at least a history feature, the solution finally came to me. It was like Obi-Wan Kenobi whispered to me, "Bryan, use the emacs." I turned off my targeting computer my gnome-terminal that was running telnet and moused over to emacs (it's always running).

"Bryan, what's wrong?" my EE partner worriedly inquired. I typed M-x shell and then telneted to the appropriate port. I typed a command. It worked. I hit M-p and the command I'd just used magically appeared at the prompt, ready for action a second time. A chorus of angels sang. I edited the parameters of the command before sending it, using all the familiar emacs shortcuts. The angels' song rose in pitch. My partner's mouth hung open. After typing a few different commands, multiple M-p's scrolled through all the past commands. A C-r began a search through the buffer history so I could quickly get to a past command I wanted, and macros and elisp were now at our disposal for scripting it. Our simple shell just got a whole lot more features.

There is really only one problem with this that I've discovered. Most of the commands we use echo any output to our serial console, but some echo back to the shell. Some of the output that goes back to the shell doesn't show up in emacs for some reason. If anyone has any tips on that one, please let me know.

Oh, and, uh, sorry for getting a little over dramatic there. I'll try to tone it down next time emacs causes me to weep with joy (dang, there I go again).

Comments

Anonymous said…
Another solution if you don't want the whole emacs hog (sacrilege!) is the readline wrapper rlwrap
April 21, 2007 at 6:11 AM
Anonymous said…
Emacs also has a telnet mode; M-x telnet RET. Many other common UNIX utilities work this way, too, e.g. M-x ftp, M-x ping, M-x traceroute, etc. See net-utils.el and telnet.el.
April 21, 2007 at 10:05 PM
Post a Comment

Popular posts from this blog

SystemVerilog Fork Disable "Gotchas"

This is a long post with a lot of SystemVerilog code. The purpose of this entry is to hopefully save you from beating your head against the wall trying to figure out some of the subtleties of SystemVerilog processes (basically, threads). Subtleties like these are commonly referred to in the industry as "Gotchas" which makes them sound so playful and fun, but they really aren't either. I encourage you to run these examples with your simulator (if you have access to one) so that a) you can see the results first hand and better internalize what's going on, and b) you can tell me in the comments if this code works fine for you and I'll know I should go complain to my simulator vendor. OK, I'll start with a warm-up that everyone who writes any Verilog or SystemVerilog at all should be aware of, tasks are static by default. If you do this: module top; task do_stuff ( int wait_time); #wait_time $display ( "waited %0d, then did stuff" , wa...
Read more

'git revert' Is Not Equivalent To 'svn revert'

I just learned that if you have some changes in your working tree that you want to get rid of, you don't type 'git revert' like you might guess. No, that's what cvs, subversion, mercurial, and bazaar (to name a few) use revert to mean, but not git. With git, revert is used to undo actual commits. Thankfully, you can undo your revert with another 'git revert', I just learned. So let me repeat to be clear, if you have changes to your working files that you want to abandon, DO NOT do this: git revert HEAD That will undo your last commit. Do this instead: git reset --hard HEAD I'm glad I have that straightened out now. I'm wondering if /etc was really a good place for me to start out playing with git. UPDATE: Nearly two years later and I'm still getting comments on this. I'm glad I've been able to help people out this way. The discussion in the comments is good, and one thing I'd like to point out is that I now always use...
Read more

SystemVerilog Streaming Operator: Knowing Right from Left

SystemVerilog has this cool feature that is very handy for converting one type of collection of bits into another type of collection of bits.  It's the streaming operator.  Or the streaming concatenation operator.  Or maybe it's the concatenation of streaming expressions (it's also called pack/unpack parenthetically).  Whatever you want to call it, it's nice.  If you have an array of bytes and you want to turn it into an int, or an array of ints that you want to turn into an array of bytes, or if you have a class instance that you want to turn into a stream of bits, then streaming is amazing.  What used to require a mess of nested for-loops can now be done with a concise single line of code. As nice as it is, getting the hang of the streaming operator is tough.  The SystemVerilog 1800-2012 LRM isn't totally clear (at least to me) on the details of how they work.  The statement from the LRM that really got me was this, "The stream_operator <...
Read more