Merge branch 'drm-intel-fixes' into drm-intel-next

What:		/sys/bus/rbd/

Date:		November 2010

Contact:	Yehuda Sadeh <yehuda@hq.newdream.net>,

		Sage Weil <sage@newdream.net>

Description:

Being used for adding and removing rbd block devices.

Usage: <mon ip addr> <options> <pool name> <rbd image name> [snap name]

 $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add

The snapshot name can be "-" or omitted to map the image read/write. A <dev-id>

will be assigned for any registered block device. If snapshot is used, it will

be mapped read-only.

Removal of a device:

  $ echo <dev-id> > /sys/bus/rbd/remove

Entries under /sys/bus/rbd/devices/<dev-id>/

--------------------------------------------

client_id

	The ceph unique client id that was assigned for this specific session.

major

	The block device major number.

name

	The name of the rbd image.

pool

	The pool where this rbd image resides. The pool-name pair is unique

	per rados system.

size

	The size (in bytes) of the mapped block device.

refresh

	Writing to this file will reread the image header data and set

	all relevant datastructures accordingly.

current_snap

	The current snapshot for which the device is mapped.

create_snap

	Create a snapshot:

	 $ echo <snap-name> > /sys/bus/rbd/devices/<dev-id>/snap_create

rollback_snap

	Rolls back data to the specified snapshot. This goes over the entire

	list of rados blocks and sends a rollback command to each.

	 $ echo <snap-name> > /sys/bus/rbd/devices/<dev-id>/snap_rollback

snap_*

	A directory per each snapshot

Entries under /sys/bus/rbd/devices/<dev-id>/snap_<snap-name>

-------------------------------------------------------------

id

	The rados internal snapshot id assigned for this snapshot

size

	The size of the image when this snapshot was taken.

      </sect2>

    </sect1>

  </chapter>

  <chapter id="clk">

    <title>Clock Framework Extensions</title>

!Iinclude/linux/sh_clk.h

  </chapter>

  <chapter id="mach">

    <title>Machine Specific Interfaces</title>

    <sect1 id="dreamcast">

Device Interfaces

Introduction

~~~~~~~~~~~~

Device interfaces are the logical interfaces of device classes that correlate

directly to userspace interfaces, like device nodes. 

Each device class may have multiple interfaces through which you can 

access the same device. An input device may support the mouse interface, 

the 'evdev' interface, and the touchscreen interface. A SCSI disk would 

support the disk interface, the SCSI generic interface, and possibly a raw 

device interface. 

Device interfaces are registered with the class they belong to. As devices

are added to the class, they are added to each interface registered with

the class. The interface is responsible for determining whether the device

supports the interface or not. 

Programming Interface

~~~~~~~~~~~~~~~~~~~~~

struct device_interface {

	char			* name;

	rwlock_t		lock;

	u32			devnum;

	struct device_class	* devclass;

	struct list_head	node;

	struct driver_dir_entry	dir;

	int (*add_device)(struct device *);

	int (*add_device)(struct intf_data *);

};

int interface_register(struct device_interface *);

void interface_unregister(struct device_interface *);

An interface must specify the device class it belongs to. It is added

to that class's list of interfaces on registration.

Interfaces can be added to a device class at any time. Whenever it is

added, each device in the class is passed to the interface's

add_device callback. When an interface is removed, each device is

removed from the interface.

Devices

~~~~~~~

Once a device is added to a device class, it is added to each

interface that is registered with the device class. The class

is expected to place a class-specific data structure in 

struct device::class_data. The interface can use that (along with

other fields of struct device) to determine whether or not the driver

and/or device support that particular interface.

Data

~~~~

struct intf_data {

	struct list_head	node;

	struct device_interface	* intf;

	struct device 		* dev;

	u32			intf_num;

};

int interface_add_data(struct interface_data *);

The interface is responsible for allocating and initializing a struct 

intf_data and calling interface_add_data() to add it to the device's list

of interfaces it belongs to. This list will be iterated over when the device

is removed from the class (instead of all possible interfaces for a class).

This structure should probably be embedded in whatever per-device data 

structure the interface is allocating anyway.

Devices are enumerated within the interface. This happens in interface_add_data()

and the enumerated value is stored in the struct intf_data for that device. 

sysfs

~~~~~

Each interface is given a directory in the directory of the device

class it belongs to:

Interfaces get a directory in the class's directory as well:

   class/

   `-- input

       |-- devices

       |-- drivers

       |-- mouse

       `-- evdev

When a device is added to the interface, a symlink is created that points 

to the device's directory in the physical hierarchy:

   class/

   `-- input

       |-- devices

       |   `-- 1 -> ../../../root/pci0/00:1f.0/usb_bus/00:1f.2-1:0/

       |-- drivers

       |   `-- usb:usb_mouse -> ../../../bus/drivers/usb_mouse/

       |-- mouse

       |   `-- 1 -> ../../../root/pci0/00:1f.0/usb_bus/00:1f.2-1:0/

       `-- evdev

           `-- 1 -> ../../../root/pci0/00:1f.0/usb_bus/00:1f.2-1:0/

Future Plans

~~~~~~~~~~~~

A device interface is correlated directly with a userspace interface

for a device, specifically a device node. For instance, a SCSI disk

exposes at least two interfaces to userspace: the standard SCSI disk

interface and the SCSI generic interface. It might also export a raw

device interface. 

Many interfaces have a major number associated with them and each

device gets a minor number. Or, multiple interfaces might share one

major number, and each will receive a range of minor numbers (like in

the case of input devices).

These major and minor numbers could be stored in the interface

structure. Major and minor allocations could happen when the interface

is registered with the class, or via a helper function. 

The representation of the above is reflected in the directory tree

in EDAC's sysfs interface. Starting in directory

/sys/devices/system/edac/mc each memory controller will be represented

by its own 'mcX' directory, where 'X" is the index of the MC.

by its own 'mcX' directory, where 'X' is the index of the MC.

	..../edac/mc/

		   ....

Under each 'mcX' directory each 'csrowX' is again represented by a

'csrowX', where 'X" is the csrow index:

'csrowX', where 'X' is the csrow index:

	.../mc/mc0/

In 'mcX' directories are EDAC control and attribute files for

this 'X" instance of the memory controllers:

this 'X' instance of the memory controllers:

Counter reset control file:

'csrowX' DIRECTORIES

In the 'csrowX' directories are EDAC control and attribute files for

this 'X" instance of csrow:

this 'X' instance of csrow:

Total Uncorrectable Errors count attribute file:

				    Geert Uytterhoeven <geert@linux-m68k.org>

00-INDEX

	- this file

	- this file.

arkfb.txt

	- info on the fbdev driver for ARK Logic chips.

aty128fb.txt

	- info on the ATI Rage128 frame buffer driver.

cirrusfb.txt

	- info on the driver for Cirrus Logic chipsets.

cmap_xfbdev.txt

	- an introduction to fbdev's cmap structures.

deferred_io.txt

	- an introduction to deferred IO.

efifb.txt

	- info on the EFI platform driver for Intel based Apple computers.

ep93xx-fb.txt

	- info on the driver for EP93xx LCD controller.

fbcon.txt

	- intro to and usage guide for the framebuffer console (fbcon).

framebuffer.txt

	- introduction to frame buffer devices.

imacfb.txt

	- info on the generic EFI platform driver for Intel based Macs.

gxfb.txt

	- info on the framebuffer driver for AMD Geode GX2 based processors.

intel810.txt

	- documentation for the Intel 810/815 framebuffer driver.

intelfb.txt

	- docs for Intel 830M/845G/852GM/855GM/865G/915G/945G fb driver.

internals.txt

	- quick overview of frame buffer device internals.

lxfb.txt

	- info on the framebuffer driver for AMD Geode LX based processors.

matroxfb.txt

	- info on the Matrox framebuffer driver for Alpha, Intel and PPC.

metronomefb.txt

	- info on the driver for the Metronome display controller.

modedb.txt

	- info on the video mode database.

matroxfb.txt

	- info on the Matrox frame buffer driver.

pvr2fb.txt

	- info on the PowerVR 2 frame buffer driver.

pxafb.txt

	- info on the fbdev driver for S3 Trio/Virge chips.

sa1100fb.txt

	- information about the driver for the SA-1100 LCD controller.

sh7760fb.txt

	- info on the SH7760/SH7763 integrated LCDC Framebuffer driver.

sisfb.txt

	- info on the framebuffer device driver for various SiS chips.

sstfb.txt

	- info on the frame buffer driver for 3dfx' Voodoo Graphics boards.

tgafb.txt

	- info on the TGA (DECChip 21030) frame buffer driver

	- info on the TGA (DECChip 21030) frame buffer driver.

tridentfb.txt

	info on the framebuffer driver for some Trident chip based cards.

uvesafb.txt

	- info on the userspace VESA (VBE2+ compliant) frame buffer device.

vesafb.txt

	- info on the VESA frame buffer device

	- info on the VESA frame buffer device.

viafb.modes

	- list of modes for VIA Integration Graphic Chip.

viafb.txt

	- info on the VIA Integration Graphic Chip console framebuffer driver.

vt8623fb.txt

	- info on the fb driver for the graphics core in VIA VT8623 chipsets.