drivers/staging/vme_user/vme.h

Source file repositories/reference/linux-study-clean/drivers/staging/vme_user/vme.h

File Facts

System
Linux kernel
Corpus path
drivers/staging/vme_user/vme.h
Extension
.h
Size
6611 bytes
Lines
191
Domain
Driver Families
Bucket
drivers/staging
Inferred role
Driver Families: operation-table or driver-model contract
Status
pattern implementation candidate

Why This File Exists

Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.

Dependency Surface

Detected Declarations

Annotated Snippet

extern const struct bus_type vme_bus_type;

/* Number of VME interrupt vectors */
#define VME_NUM_STATUSID	256

/* VME_MAX_BRIDGES comes from the type of vme_bus_numbers */
#define VME_MAX_BRIDGES		(sizeof(unsigned int) * 8)
#define VME_MAX_SLOTS		32

#define VME_SLOT_CURRENT	-1
#define VME_SLOT_ALL		-2

/**
 * struct vme_dev - Structure representing a VME device
 * @num: The device number
 * @bridge: Pointer to the bridge device this device is on
 * @dev: Internal device structure
 * @drv_list: List of devices (per driver)
 * @bridge_list: List of devices (per bridge)
 */
struct vme_dev {
	int num;
	struct vme_bridge *bridge;
	struct device dev;
	struct list_head drv_list;
	struct list_head bridge_list;
};

/**
 * struct vme_driver - Structure representing a VME driver
 * @name: Driver name, should be unique among VME drivers and usually the same
 *        as the module name.
 * @match: Callback used to determine whether probe should be run.
 * @probe: Callback for device binding, called when new device is detected.
 * @remove: Callback, called on device removal.
 * @driver: Underlying generic device driver structure.
 * @devices: List of VME devices (struct vme_dev) associated with this driver.
 */
struct vme_driver {
	const char *name;
	int (*match)(struct vme_dev *vdev);
	int (*probe)(struct vme_dev *vdev);
	void (*remove)(struct vme_dev *vdev);
	struct device_driver driver;
	struct list_head devices;
};

void *vme_alloc_consistent(struct vme_resource *resource, size_t size, dma_addr_t *dma);
void vme_free_consistent(struct vme_resource *resource, size_t size, void *vaddr, dma_addr_t dma);

size_t vme_get_size(struct vme_resource *resource);
int vme_check_window(struct vme_bridge *bridge, u32 aspace,
		     unsigned long long vme_base, unsigned long long size);

struct vme_resource *vme_slave_request(struct vme_dev *vdev, u32 address, u32 cycle);
int vme_slave_set(struct vme_resource *resource, int enabled, unsigned long long vme_base,
		  unsigned long long size, dma_addr_t buf_base, u32 aspace, u32 cycle);
int vme_slave_get(struct vme_resource *resource, int *enabled, unsigned long long *vme_base,
		  unsigned long long *size, dma_addr_t *buf_base, u32 *aspace, u32 *cycle);
void vme_slave_free(struct vme_resource *resource);

struct vme_resource *vme_master_request(struct vme_dev *vdev, u32 address, u32 cycle, u32 dwidth);
int vme_master_set(struct vme_resource *resource, int enabled, unsigned long long vme_base,
		   unsigned long long size, u32 aspace, u32 cycle, u32 dwidth);
int vme_master_get(struct vme_resource *resource, int *enabled, unsigned long long *vme_base,
		   unsigned long long *size, u32 *aspace, u32 *cycle, u32 *dwidth);
ssize_t vme_master_read(struct vme_resource *resource, void *buf, size_t count, loff_t offset);
ssize_t vme_master_write(struct vme_resource *resource, void *buf, size_t count, loff_t offset);
unsigned int vme_master_rmw(struct vme_resource *resource, unsigned int mask, unsigned int compare,
			    unsigned int swap, loff_t offset);
int vme_master_mmap_prepare(struct vme_resource *resource, struct vm_area_desc *desc);
void vme_master_free(struct vme_resource *resource);

struct vme_resource *vme_dma_request(struct vme_dev *vdev, u32 route);
struct vme_dma_list *vme_new_dma_list(struct vme_resource *resource);
struct vme_dma_attr *vme_dma_pattern_attribute(u32 pattern, u32 type);
struct vme_dma_attr *vme_dma_pci_attribute(dma_addr_t address);
struct vme_dma_attr *vme_dma_vme_attribute(unsigned long long address,
					   u32 aspace, u32 cycle, u32 dwidth);
void vme_dma_free_attribute(struct vme_dma_attr *attributes);
int vme_dma_list_add(struct vme_dma_list *list, struct vme_dma_attr *src,
		     struct vme_dma_attr *dest, size_t count);
int vme_dma_list_exec(struct vme_dma_list *list);
int vme_dma_list_free(struct vme_dma_list *list);
int vme_dma_free(struct vme_resource *resource);

int vme_irq_request(struct vme_dev *vdev, int level, int statid,
		    void (*callback)(int level, int statid, void *priv_data), void *priv_data);
void vme_irq_free(struct vme_dev *vdev, int level, int statid);
int vme_irq_generate(struct vme_dev *vdev, int level, int statid);

Annotation

Implementation Notes