Difference between revisions of "Quick Reference"

Revision as of 12:36, 15 November 2013

This page is a quick reference guide or a "cheatsheet" to assist with the initial learning curve. Once full familiarity with the development environment is established, this quick reference will likely no longer be needed.

Working With the Terminal

Use minicom to bring up a serial terminal. To configure the serial console, run minicom -s. Select, Save as dfl, to save the settings you have configured to be the default settings whenever you run minicom. Use minicom -o to start minicom more quickly; the -o option tells minicom to start without sending AT commands to initialize a modem.

The settings needed for configuring minicom can be found on this page.

Making Changes To The Target Machine's Fileystem

By default, the flash filesystem on most EMAC devices is mounted read-only. To make changes to the filesystem, it will have to be remounted as read-write. This can be done with the following command:

root@emac-oe:~# mount -o remount,rw /

To mount the filesystem as read-only again (without rebooting), type:

root@emac-oe:~# mount -o remount,ro /

Mounting a Flash Filesystem

There are four steps to mounting a flash filesystem on our EMAC OE machine:

Determine which device node is assigned to the flash device.
Determine which partition to mount.
Determine where to mount the device.
Mount the device.

Determining the Device Node Assigned to the Flash Device

The easiest way to determine which device node is assigned to a particular flash device is to inspect the output of the dmesg command shortly after the device has been connected to your machine. Follow these steps to do so:

Insert the SD, CF or microSD card or plug in the USB flash device to your EMAC OE machine.
Wait a few seconds for the device to settle and be recognized by the OS.
Run this command at at shell on your EMAC OE machine:
```
root@emac-oe:~# dmesg | tail -n 15
```

Inspect the output. The output should look similar to the following:

usb 2-2: new full speed USB device using at91_ohci and address 2
usb 2-2: not running at top speed; connect to a high speed hub
usb 2-2: configuration #1 chosen from 1 choice
scsi0 : SCSI emulation for USB Mass Storage devices
usb-storage: device found at 2
usb-storage: waiting for device to settle before scanning
scsi 0:0:0:0: Direct-Access              Patriot Memory   PMAP PQ: 0 ANSI: 4
usb-storage: device scan complete
sd 0:0:0:0: [sda] 15634432 512-byte hardware sectors: (8.00 GB/7.45 GiB)
sd 0:0:0:0: [sda] Write Protect is off
sd 0:0:0:0: [sda] Mode Sense: 23 00 00 00
sd 0:0:0:0: [sda] Assuming drive cache: write through
sd 0:0:0:0: [sda] Assuming drive cache: write through 
sda: sda1
sd 0:0:0:0: [sda] Attached SCSI removable disk

Inside square brackets, we see sda. This is the root device node assigned to our flash device.

Determine Which Partition to Mount

On a line by itself, we see:

sda: sda1

This means one partition was found on our device: sda1. This is the partition we will use.

Determine Where to Mount the Device

Now that we know what device node we are going to mount, we need to determine where to mount it. The /mnt directory is typically used for this (mnt is short for mount).

Create a directory to use for the mountpoint:

root@emac-oe:~# mkdir /mnt/myflash

Alternatively, you can pick another place in the filesystem to use. Just make sure you have permission to create a directory in that location. If the directory contains files, it will still be used as the mountpoint when the mount command is issued; however, the files contained in the directory will be hidden for as long as the directory is in use as a mountpoint. This could create a great deal of confusion, so beware this potential pitfall.

Mount the Device

Now that sda1 has been determined to be the partition to mount and /mnt/myflash has been created to be used as the mountpoint, we can mount our flash device with the following command:

root@emac-oe:~# mount /dev/sda1 /mnt/myflash

If no message is returned from the above command, then it succeeded. To verify this, try the following command

root@emac-oe:~# mount | grep sda1

You should see your device listed in the output of the above command. If it is listed more than once, it may have been mounted automatically by the OS. If so, inspection of the output should show you where it was mounted.

Unmounting the Filesystem After Use

After you are finished using the flash device, you may wish to unmount it (similar to "Safely Removing" a device on other operating systems). The umount command is used for this purpose.

Continuing on with the example above, the device mounted above would be unmounted with the following command:

root@emac-oe:~# umount /mnt/myflash

If it was automounted elsewhere, it will also need to be unmounted from that mountpoint before it will be safe to remove the device. For instance, if the automounter mounted it on /media/sda1, then issue the following command:

root@emac-oe:~# umount /media/sda1

@@ Line 1: / Line 1: @@
-{{todo|Port/Polish (11.15.13-11:35->KY+)|Klint Youngmeyer|project=oe 4,oe 5,ky,inprogress}}
+{{todo|Polish (11.15.13-12:35->KY)|Klint Youngmeyer|project=oe 4,oe 5,ky,inprogress}}
+This page is a quick reference guide or a "cheatsheet" to assist with the initial learning curve. Once full familiarity with the development environment is established, this quick reference will likely no longer be needed.
 == Working With the Terminal ==
+Use <code>minicom</code> to bring up a serial terminal.  To configure the serial console, run <code>minicom -s</code>.  Select, <code>Save as dfl</code>, to save the settings you have configured to be the default settings whenever you run <code>minicom</code>.  Use <code>minicom -o</code> to start <code>minicom</code> more quickly; the <code>-o</code> option tells <code>minicom</code> to start without sending <code>AT</code> commands to initialize a modem.
+The settings needed for configuring <code>minicom</code> can be found [[EMAC_OE_Getting_Started_Guide|on this page]].
 == Making Changes To The Target Machine's Fileystem ==
+By default, the flash filesystem on most EMAC devices is mounted read-only.  To make changes to the filesystem, it will have to be remounted as read-write.  This can be done with the following command:
+<syntaxhighlight lang=bash>
+root@emac-oe:~# mount -o remount,rw /</syntaxhighlight>
-==Mounting a Flash Filesystem==
+To mount the filesystem as read-only again (without rebooting), type:
+<syntaxhighlight lang=bash>
+root@emac-oe:~# mount -o remount,ro /</syntaxhighlight>
+==Mounting a Flash Filesystem==
+There are four steps to mounting a flash filesystem on our EMAC OE machine:
+<cl>
+. Determine which device node is assigned to the flash device.
+* Determine which partition to mount.
+* Determine where to mount the device.
+* Mount the device.
+</cl>
+<br clear=all>
+{{mbox  | type=notice | text='''NOTE''': You '''must''' have <code>root</code> permissions to perform some of the following steps.  Make sure you are logged in as the <code>root</code> user prior to performing the following steps.  The <code>su</code> command can be useful for this.  The filesystem will also need to be mounted read/write in order to create the directory mentioned below.  See the section regarding remounting the root filesystem as read/write (above) to see how to do this.}}
+<br clear=all>
 ===Determining the Device Node Assigned to the Flash Device===
+The easiest way to determine which device node is assigned to a particular flash device is to inspect the output of the ''dmesg'' command shortly after the device has been connected to your machine.  Follow these steps to do so:
+<cl>
+. Insert the SD, CF or microSD card or plug in the USB flash device to your EMAC OE machine.
+* Wait a few seconds for the device to settle and be recognized by the OS.
+* Run this command at at shell on your EMAC OE machine: <br clear=all> <syntaxhighlight lang=bash>root@emac-oe:~# dmesg | tail -n 15</syntaxhighlight>
+* Inspect the output. The output should look similar to the following:
+<syntaxhighlight lang=console>
+usb 2-2: new full speed USB device using at91_ohci and address 2
+usb 2-2: not running at top speed; connect to a high speed hub
+usb 2-2: configuration #1 chosen from 1 choice
+scsi0 : SCSI emulation for USB Mass Storage devices
+usb-storage: device found at 2
+usb-storage: waiting for device to settle before scanning
+scsi 0:0:0:0: Direct-Access              Patriot Memory   PMAP PQ: 0 ANSI: 4
+usb-storage: device scan complete
+sd 0:0:0:0: [sda] 15634432 512-byte hardware sectors: (8.00 GB/7.45 GiB)
+sd 0:0:0:0: [sda] Write Protect is off
+sd 0:0:0:0: [sda] Mode Sense: 23 00 00 00
+sd 0:0:0:0: [sda] Assuming drive cache: write through
+sd 0:0:0:0: [sda] Assuming drive cache: write through
+sda: sda1
+sd 0:0:0:0: [sda] Attached SCSI removable disk
+</syntaxhighlight>
+Inside square brackets, we see <code>sda</code>.  This is the root device node assigned to our flash device.
+</cl>
 ===Determine Which Partition to Mount===
+On a line by itself, we see:
+<syntaxhighlight lang=console>sda: sda1</syntaxhighlight>
+This means one partition was found on our device: ''sda1''.  This is the partition we will use.
+<br clear=all>{{mbox | type=notice | text='''NOTE''': If there is more than one partition, you will need to decide which partition to use based on your knowledge of the paritions on the device.  The partition device node assignment will be listed in order in the output above.  If the first partition is <code>sda1</code>, and the second one is <code>sda5</code>, that is not an error.  Only 4 ''primary partitions'' can exist on a device.  If the second partition is number 5, that means it was created as an ''extended partition''.}}
+<br clear=all>
+===Determine Where to Mount the Device===
+Now that we know what device node we are going to mount, we need to determine where to mount it.  The <code>/mnt</code> directory is typically used for this (<code>mnt</code> is short for ''mount'').
-===Determine Where to Mount the Device===
+Create a directory to use for the mountpoint:
+<syntaxhighlight lang=bash>root@emac-oe:~# mkdir /mnt/myflash</syntaxhighlight>
+Alternatively, you can pick another place in the filesystem to use.  Just make sure you have permission to create a directory in that location.  If the directory contains files, it will still be used as the mountpoint when the ''mount'' command is issued; however, the files contained in the directory will be hidden for as long as the directory is in use as a mountpoint.  This could create a great deal of confusion, so beware this potential pitfall.
+<br clear=all>{{mbox | type=notice | text='''NOTE''' The ''mountpoint'' (where a device is mounted) is the directory which is used to host the root of the filesystem located on the device.  In other words, if this were a machine running an operating system from Microsoft, the ''mountpoint'' would be a drive letter such as <code>D:</code> or <code>Z:</code>.  In Linux (and Unix), there are no drive letters.  Directories are used instead.  Beneficially, using directories instead of drive letters makes things more consistent (and therefore simpler) from a programming standpoint.}}<br clear=all>
 ===Mount the Device===
+Now that ''sda1'' has been determined to be the partition to mount and ''/mnt/myflash'' has been created to be used as the mountpoint, we can mount our flash device with the following command:
+<syntaxhighlight lang=bash>root@emac-oe:~# mount /dev/sda1 /mnt/myflash</syntaxhighlight>
+If no message is returned from the above command, then it succeeded.  To verify this, try the following command
+<syntaxhighlight lang=bash>root@emac-oe:~# mount | grep sda1</syntaxhighlight>
+You should see your device listed in the output of the above command.  If it is listed more than once, it may have been mounted automatically by the OS.  If so, inspection of the output should show you where it was mounted.
+<br clear=all>{{mbox | type=notice | text='''NOTE''': If the device node was something other than <code>sda1</code>, then replace <code>sda1</code> in the command above with the device node you determine for your flash device in the ''Determine Which Partition to Mount'' section above.}}<br clear=all>
+==Unmounting the Filesystem After Use==
+After you are finished using the flash device, you may wish to unmount it (similar to "Safely Removing" a device on other operating systems).  The ''umount'' command is used for this purpose.
+Continuing on with the example above, the device mounted above would be unmounted with the following command:
+<syntaxhighlight lang=bash>root@emac-oe:~# umount /mnt/myflash</syntaxhighlight>
+If it was automounted elsewhere, it will also need to be unmounted from that mountpoint before it will be safe to remove the device.  For instance, if the automounter mounted it on ''/media/sda1'', then issue the following command:
+<syntaxhighlight lang=bash>root@emac-oe:~# umount /media/sda1</syntaxhighlight>
+<br clear=all>{{mbox | typ=notice | text='''TIP''': The <code>sync</code> command can also be handy for ensuring data written to a device is flushed to disk prior to performing some other activity with the device.}}<br clear=all>
+==See Also==
+* [[Getting Started with Linux]]
+* [[EMAC OE Getting Started Guide]]
+* [[Open Source Community]]
-===Unmounting the Filesystem After Use===
+[[Category: Support]]

Difference between revisions of "Quick Reference"

Revision as of 12:36, 15 November 2013

Contents

Working With the Terminal

Making Changes To The Target Machine's Fileystem

Mounting a Flash Filesystem

Determining the Device Node Assigned to the Flash Device

Determine Which Partition to Mount

Determine Where to Mount the Device

Mount the Device

Unmounting the Filesystem After Use

See Also

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

OE 5.0 Wiki

OE 4.0 Wiki

Support

Miscellaneous

Tools