spi.h

Go to the documentation of this file.

/*
 *  linux/include/linux/spi/spi.h
 *
 *  Copyright (C) 2001 Russell King, All Rights Reserved.
 *  Copyright (C) 2002 Compaq Computer Corporation, All Rights Reserved.
 *  Copyright (C) 2004 Kate Alhola, All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License.
 *
 * Derived from l3.h by Jamey Hicks
 */
#ifndef SPI_H
#define SPI_H

struct spi_msg {
    unsigned char       addr;   
    unsigned char       flags;  
#define SPI_M_RD        0x01    
#define SPI_M_WR        0x02    
#define SPI_M_NOADDR    0x04
#define SPI_CS          0x08    
        unsigned short  len;    
        unsigned char   *buf;   
};

#ifdef __KERNEL__

#include <linux/types.h>
#include <linux/list.h>


#define SPI_MAJOR 228  /* This will change */

struct spi_client;
struct spi_adapter;

struct spi_ops {
        int     (*open)(struct spi_client *);
        int     (*command)(struct spi_client *, int cmd, void *arg);
        void    (*close)(struct spi_client *);
};

struct spi_driver {
    char                        name[32];

        unsigned int flags;             /* div., see below              */

        int                     (*attach_adapter)(struct spi_adapter *);

        void                    (*detach_client)(struct spi_client *);

        int (*command)(struct spi_client *client,unsigned int cmd, void *arg);
        struct spi_ops          *ops;

        struct module           *owner;

        /*
         * drivers list
         */
        struct list_head        drivers;

        void (*inc_use)(struct spi_client *client);
        void (*dec_use)(struct spi_client *client);
};

#define SPI_DF_NOTIFY   0x01            /* notify on bus (de/a)ttaches  */
#define SPI_DF_DUMMY    0x02            /* do not connect any clients */


struct spi_algorithm {

        char name[32];     
        int (*xfer)(struct spi_adapter *, struct spi_msg msgs[], int num);     
};

struct spi_cs {
        char name[32];
        int id;
};

struct semaphore;

struct spi_adapter {
        char                    name[32];

        struct spi_algorithm    *algo;

        void                    *algo_data;

        int (* set_spi_adap_cs)(struct spi_adapter *,int id,int val);
        struct spi_cs *cs;
        struct module           *owner;

        void                    *data;

        struct semaphore        lock;

        int inode;

        int   id;
        struct list_head        clients;

        struct list_head        adapters;
};

struct spi_client {
        char                    name[32];
        struct spi_adapter      *adapter;       
        struct spi_driver       *driver;        
        void                    *driver_data;   
        struct list_head        __adap;
        int                     addr;           
};


extern int spi_add_adapter(struct spi_adapter *);
extern int spi_del_adapter(struct spi_adapter *);

extern int spi_add_driver(struct spi_driver *);
extern int spi_del_driver(struct spi_driver *);

extern int spi_attach_client(struct spi_client *, const char *, const char *);
extern int spi_detach_client(struct spi_client *);

extern int spi_transfer(struct spi_adapter *, struct spi_msg msgs[], int);
extern int spi_write(struct spi_client *, int, const char *, int);
extern int spi_read(struct spi_client *, int, char *, int);
/* This call returns a unique low identifier for each registered adapter,
 * or -1 if the adapter was not registered. 
 */
extern int spi_adapter_id(struct spi_adapter *adap);

static inline int spi_command(struct spi_client *clnt, int cmd, void *arg)
{
        struct spi_ops *ops = clnt->driver->ops;
        int ret = -EINVAL;

        if (ops && ops->command)
                ret = ops->command(clnt, cmd, arg);

        return ret;
}

static inline int spi_open(struct spi_client *clnt)
{
        struct spi_ops *ops = clnt->driver->ops;
        int ret = 0;

        if (ops && ops->open)
                ret = ops->open(clnt);
        return ret;
}

static inline void spi_close(struct spi_client *clnt)
{
        struct spi_ops *ops = clnt->driver->ops;
        if (ops && ops->close)
                ops->close(clnt);
}
#endif

#define SPI_RDWR        0x6207  
#define SPI_SETADDR     0x6206  
#define SPI_FUNCS       0x6205  
struct spi_rdwr_ioctl_data {
        struct spi_msg *msgs;   
        unsigned int   nmsgs;   
};


#endif /* SPI_H */

---