Commit 01d13145 authored by Ben Walker's avatar Ben Walker
Browse files

scsi: Flesh out the public header file 



The public header file was missing some required definitions.

Change-Id: Ic4f8028367b1e21ea00c02660ca36be28da54e37
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 720f0e77

include/spdk/endian.h

0 → 100644
+115 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright (c) Intel Corporation.

 *   All rights reserved.

 *

 *   Redistribution and use in source and binary forms, with or without

 *   modification, are permitted provided that the following conditions

 *   are met:

 *

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in

 *       the documentation and/or other materials provided with the

 *       distribution.

 *     * Neither the name of Intel Corporation nor the names of its

 *       contributors may be used to endorse or promote products derived

 *       from this software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



/**

* \file

* Endian conversion functions

*/



#ifndef SPDK_ENDIAN_H

#define SPDK_ENDIAN_H



#ifdef __cplusplus

extern "C" {

#endif



#include <stdint.h>



static inline uint16_t

from_be16(void *ptr)

{

	uint8_t *tmp = (uint8_t *)ptr;

	return (((uint16_t)tmp[0] << 8) | tmp[1]);

}



static inline void

to_be16(void *out, uint16_t in)

{

	uint8_t *tmp = (uint8_t *)out;

	tmp[0] = (in >> 8) & 0xFF;

	tmp[1] = in & 0xFF;

}



static inline uint32_t

from_be32(void *ptr)

{

	uint8_t *tmp = (uint8_t *)ptr;

	return (((uint32_t)tmp[0] << 24) |

		((uint32_t)tmp[1] << 16) |

		((uint32_t)tmp[2] << 8) |

		((uint32_t)tmp[3]));

}



static inline void

to_be32(void *out, uint32_t in)

{

	uint8_t *tmp = (uint8_t *)out;

	tmp[0] = (in >> 24) & 0xFF;

	tmp[1] = (in >> 16) & 0xFF;

	tmp[2] = (in >> 8) & 0xFF;

	tmp[3] = in & 0xFF;

}



static inline uint64_t

from_be64(void *ptr)

{

	uint8_t *tmp = (uint8_t *)ptr;

	return (((uint64_t)tmp[0] << 56) |

		((uint64_t)tmp[1] << 48) |

		((uint64_t)tmp[2] << 40) |

		((uint64_t)tmp[3] << 32) |

		((uint64_t)tmp[4] << 24) |

		((uint64_t)tmp[5] << 16) |

		((uint64_t)tmp[6] << 8) |

		((uint64_t)tmp[7]));

}



static inline void

to_be64(void *out, uint64_t in)

{

	uint8_t *tmp = (uint8_t *)out;

	tmp[0] = (in >> 56) & 0xFF;

	tmp[1] = (in >> 48) & 0xFF;

	tmp[2] = (in >> 40) & 0xFF;

	tmp[3] = (in >> 32) & 0xFF;

	tmp[4] = (in >> 24) & 0xFF;

	tmp[5] = (in >> 16) & 0xFF;

	tmp[6] = (in >> 8) & 0xFF;

	tmp[7] = in & 0xFF;

}



#ifdef __cplusplus

}

#endif



#endif

include/spdk/scsi.h

+42 −0
Original line number Diff line number Diff line
@@ -73,6 +73,20 @@ enum spdk_scsi_task_type { 
	SPDK_SCSI_TASK_TYPE_MANAGE,

};



/*

 * SAM does not define the value for these service responses.  Each transport

 *  (i.e. SAS, FC, iSCSI) will map these value to transport-specific codes,

 *  and may add their own.

 */

enum spdk_scsi_task_mgmt_resp {

	SPDK_SCSI_TASK_MGMT_RESP_COMPLETE,

	SPDK_SCSI_TASK_MGMT_RESP_SUCCESS,

	SPDK_SCSI_TASK_MGMT_RESP_REJECT,

	SPDK_SCSI_TASK_MGMT_RESP_INVALID_LUN,

	SPDK_SCSI_TASK_MGMT_RESP_TARGET_FAILURE,

	SPDK_SCSI_TASK_MGMT_RESP_REJECT_FUNC_NOT_SUPPORTED

};



struct spdk_scsi_task {

	uint8_t				type;

	uint8_t				status;
@@ -151,6 +165,34 @@ struct spdk_scsi_dev { 
	struct spdk_scsi_port	port[SPDK_SCSI_DEV_MAX_PORTS];

};



/**



\brief Represents a SCSI LUN.



LUN modules will implement the function pointers specifically for the LUN

type.  For example, NVMe LUNs will implement scsi_execute to translate

the SCSI task to an NVMe command and post it to the NVMe controller.

malloc LUNs will implement scsi_execute to translate the SCSI task and

copy the task's data into or out of the allocated memory buffer.



*/

struct spdk_scsi_lun {

	/** LUN id for this logical unit. */

	int id;



	/** Pointer to the SCSI device containing this LUN. */

	struct spdk_scsi_dev *dev;



	/** The blockdev associated with this LUN. */

	struct spdk_bdev *bdev;



	/** Name for this LUN. */

	char name[SPDK_SCSI_LUN_MAX_NAME_LENGTH];



	TAILQ_HEAD(tasks, spdk_scsi_task) tasks;			/* submitted tasks */

	TAILQ_HEAD(pending_tasks, spdk_scsi_task) pending_tasks;	/* pending tasks */

};



void spdk_scsi_dev_destruct(struct spdk_scsi_dev *dev);

void spdk_scsi_dev_queue_mgmt_task(struct spdk_scsi_dev *dev, struct spdk_scsi_task *task);

void spdk_scsi_dev_queue_task(struct spdk_scsi_dev *dev, struct spdk_scsi_task *task);

lib/scsi/lun.c

+1 −0
Original line number Diff line number Diff line
@@ -33,6 +33,7 @@ 
 */



#include "scsi_internal.h"

#include "spdk/endian.h"



void

spdk_scsi_lun_complete_task(struct spdk_scsi_lun *lun, struct spdk_scsi_task *task)

lib/scsi/scsi_bdev.c

+1 −0
Original line number Diff line number Diff line
@@ -33,6 +33,7 @@ 
 */



#include "scsi_internal.h"

#include "spdk/endian.h"



#define SPDK_WORK_BLOCK_SIZE		(1ULL * 1024ULL * 1024ULL)

#define SPDK_WORK_ATS_BLOCK_SIZE	(1ULL * 1024ULL * 1024ULL)

lib/scsi/scsi_internal.h

+0 −105
Original line number Diff line number Diff line
@@ -61,20 +61,6 @@ enum { 
	SPDK_SCSI_TASK_PENDING,

};



/*

 * SAM does not define the value for these service responses.  Each transport

 *  (i.e. SAS, FC, iSCSI) will map these value to transport-specific codes,

 *  and may add their own.

 */

enum spdk_scsi_task_mgmt_resp {

	SPDK_SCSI_TASK_MGMT_RESP_COMPLETE,

	SPDK_SCSI_TASK_MGMT_RESP_SUCCESS,

	SPDK_SCSI_TASK_MGMT_RESP_REJECT,

	SPDK_SCSI_TASK_MGMT_RESP_INVALID_LUN,

	SPDK_SCSI_TASK_MGMT_RESP_TARGET_FAILURE,

	SPDK_SCSI_TASK_MGMT_RESP_REJECT_FUNC_NOT_SUPPORTED

};



#define OWNER_SCSI_DEV		0x10



#define OBJECT_SCSI_TASK	0x10
@@ -83,34 +69,6 @@ enum spdk_scsi_task_mgmt_resp { 
#define TRACE_SCSI_TASK_DONE	SPDK_TPOINT_ID(TRACE_GROUP_SCSI, 0x0)

#define TRACE_SCSI_TASK_START	SPDK_TPOINT_ID(TRACE_GROUP_SCSI, 0x1)



/**



\brief Represents a SCSI LUN.



LUN modules will implement the function pointers specifically for the LUN

type.  For example, NVMe LUNs will implement scsi_execute to translate

the SCSI task to an NVMe command and post it to the NVMe controller.

malloc LUNs will implement scsi_execute to translate the SCSI task and

copy the task's data into or out of the allocated memory buffer.



*/

struct spdk_scsi_lun {

	/** LUN id for this logical unit. */

	int id;



	/** Pointer to the SCSI device containing this LUN. */

	struct spdk_scsi_dev *dev;



	/** The blockdev associated with this LUN. */

	struct spdk_bdev *bdev;



	/** Name for this LUN. */

	char name[SPDK_SCSI_LUN_MAX_NAME_LENGTH];



	TAILQ_HEAD(tasks, spdk_scsi_task) tasks;			/* submitted tasks */

	TAILQ_HEAD(pending_tasks, spdk_scsi_task) pending_tasks;	/* pending tasks */

};



struct spdk_lun_db_entry {

	struct spdk_scsi_lun *lun;

	int claimed;
@@ -147,69 +105,6 @@ struct spdk_scsi_dev *spdk_scsi_dev_get_list(void); 
int spdk_bdev_scsi_execute(struct spdk_bdev *bdev, struct spdk_scsi_task *task);

int spdk_bdev_scsi_reset(struct spdk_bdev *bdev, struct spdk_scsi_task *task);



static inline uint16_t

from_be16(void *ptr)

{

	uint8_t *tmp = (uint8_t *)ptr;

	return (((uint16_t)tmp[0] << 8) | tmp[1]);

}



static inline void

to_be16(void *out, uint16_t in)

{

	uint8_t *tmp = (uint8_t *)out;

	tmp[0] = (in >> 8) & 0xFF;

	tmp[1] = in & 0xFF;

}



static inline uint32_t

from_be32(void *ptr)

{

	uint8_t *tmp = (uint8_t *)ptr;

	return (((uint32_t)tmp[0] << 24) |

		((uint32_t)tmp[1] << 16) |

		((uint32_t)tmp[2] << 8) |

		((uint32_t)tmp[3]));

}



static inline void

to_be32(void *out, uint32_t in)

{

	uint8_t *tmp = (uint8_t *)out;

	tmp[0] = (in >> 24) & 0xFF;

	tmp[1] = (in >> 16) & 0xFF;

	tmp[2] = (in >> 8) & 0xFF;

	tmp[3] = in & 0xFF;

}



static inline uint64_t

from_be64(void *ptr)

{

	uint8_t *tmp = (uint8_t *)ptr;

	return (((uint64_t)tmp[0] << 56) |

		((uint64_t)tmp[1] << 48) |

		((uint64_t)tmp[2] << 40) |

		((uint64_t)tmp[3] << 32) |

		((uint64_t)tmp[4] << 24) |

		((uint64_t)tmp[5] << 16) |

		((uint64_t)tmp[6] << 8) |

		((uint64_t)tmp[7]));

}



static inline void

to_be64(void *out, uint64_t in)

{

	uint8_t *tmp = (uint8_t *)out;

	tmp[0] = (in >> 56) & 0xFF;

	tmp[1] = (in >> 48) & 0xFF;

	tmp[2] = (in >> 40) & 0xFF;

	tmp[3] = (in >> 32) & 0xFF;

	tmp[4] = (in >> 24) & 0xFF;

	tmp[5] = (in >> 16) & 0xFF;

	tmp[6] = (in >> 8) & 0xFF;

	tmp[7] = in & 0xFF;

};



struct spdk_scsi_parameters {

	uint32_t max_unmap_lba_count;

	uint32_t max_unmap_block_descriptor_count;