Home | History | Annotate | Download | only in mmc
      1 #ifndef LINUX_MMC_IOCTL_H
      2 #define LINUX_MMC_IOCTL_H
      3 
      4 #include <linux/types.h>
      5 
      6 struct mmc_ioc_cmd {
      7 	/* Implies direction of data.  true = write, false = read */
      8 	int write_flag;
      9 
     10 	/* Application-specific command.  true = precede with CMD55 */
     11 	int is_acmd;
     12 
     13 	__u32 opcode;
     14 	__u32 arg;
     15 	__u32 response[4];  /* CMD response */
     16 	unsigned int flags;
     17 	unsigned int blksz;
     18 	unsigned int blocks;
     19 
     20 	/*
     21 	 * Sleep at least postsleep_min_us useconds, and at most
     22 	 * postsleep_max_us useconds *after* issuing command.  Needed for
     23 	 * some read commands for which cards have no other way of indicating
     24 	 * they're ready for the next command (i.e. there is no equivalent of
     25 	 * a "busy" indicator for read operations).
     26 	 */
     27 	unsigned int postsleep_min_us;
     28 	unsigned int postsleep_max_us;
     29 
     30 	/*
     31 	 * Override driver-computed timeouts.  Note the difference in units!
     32 	 */
     33 	unsigned int data_timeout_ns;
     34 	unsigned int cmd_timeout_ms;
     35 
     36 	/*
     37 	 * For 64-bit machines, the next member, ``__u64 data_ptr``, wants to
     38 	 * be 8-byte aligned.  Make sure this struct is the same size when
     39 	 * built for 32-bit.
     40 	 */
     41 	__u32 __pad;
     42 
     43 	/* DAT buffer */
     44 	__u64 data_ptr;
     45 };
     46 #define mmc_ioc_cmd_set_data(ic, ptr) ic.data_ptr = (__u64)(unsigned long) ptr
     47 
     48 #define MMC_IOC_CMD _IOWR(MMC_BLOCK_MAJOR, 0, struct mmc_ioc_cmd)
     49 
     50 /**
     51  * There are four request types that are applicable for rpmb accesses- two
     52  * under read category and two under write. They are
     53  *
     54  *  Reads
     55  *  -------
     56  *  1. Read Write Counter
     57  *  2. Authenticated data read
     58  *
     59  *
     60  *  Writes
     61  *  -------
     62  *  1. Provision RPMB key (though it might be done in a secure environment)
     63  *  2. Authenticated data write
     64  *
     65  *  While its given that the rpmb data frames are going to have that
     66  *  information encoded in it and the frames should be generated by a secure
     67  *  piece of code, the request types can be classified as above.
     68  *
     69  *  So here are the set of commands that should be executed atomically in the
     70  *  ioctl for rpmb read operation
     71  *  1. Switch partition
     72  *  2. Set block count
     73  *  3. Write data frame - CMD25 to write the rpmb data frame
     74  *  4. Set block count
     75  *  5. Read the data - CMD18 to do the actual read
     76  *
     77  *  Similarly for rpmb write operation, these are the commands that should be
     78  *  executed atomically in the ioctl for rpmb write operation
     79  *  1. Switch partition
     80  *  2. Set block count
     81  *  3. Write data frame - CMD25 to write the rpmb data frame with data
     82  *  4. Set block count
     83  *  5. Read the data - CMD25 to write rpmb data frame indicating that rpmb
     84  *     result register is about to be read
     85  *  6. Set block count
     86  *  7. Read rpmb result - CMD18 to read the rpmb result register
     87  *
     88  * Each of the above commands should be sent individually via struct mmc_ioc_cmd
     89  * and fields like is_acmd that are not needed for rpmb operations will be
     90  * ignored.
     91  */
     92 #define MMC_IOC_MAX_RPMB_CMD	3
     93 struct mmc_ioc_rpmb {
     94 	struct mmc_ioc_cmd cmds[MMC_IOC_MAX_RPMB_CMD];
     95 };
     96 
     97 /*
     98  * This ioctl is meant for use with rpmb partitions. This is needed since the
     99  * access procedure for this particular partition is different from regular
    100  * or normal partitions.
    101  */
    102 #define MMC_IOC_RPMB_CMD _IOWR(MMC_BLOCK_MAJOR, 0, struct mmc_ioc_rpmb)
    103 
    104 /*
    105  * Since this ioctl is only meant to enhance (and not replace) normal access
    106  * to the mmc bus device, an upper data transfer limit of MMC_IOC_MAX_BYTES
    107  * is enforced per ioctl call.  For larger data transfers, use the normal
    108  * block device operations.
    109  */
    110 #define MMC_IOC_MAX_BYTES  (512L * 256)
    111 #endif /* LINUX_MMC_IOCTL_H */
    112