ocs_ramd_thread.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015, Emulex
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the copyright holder 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 HOLDER 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
 *
 */

#if !defined(__OCS_RAMD_THREAD_H__)
#define __OCS_RAMD_THREAD_H__

typedef enum {
    OCS_RAMD_CMD_RECV_CMD = 1,
    OCS_RAMD_CMD_DATAPHASE_CB,
    OCS_RAMD_CMD_IO_CB,
    OCS_RAMD_CMD_BOUNCE,
    OCS_RAMD_CMD_MAX,
} ocs_ramd_cmd_e;

typedef struct {
    ocs_io_t *io;
    uint32_t lun;
    uint8_t cdb[32];        /* TODO: Need max CDB length? */
    uint32_t cdb_len;
    uint32_t flags;
    ocs_list_link_t link;
} ocs_ramd_cmd_recv_cmd_t;

typedef struct {
    ocs_io_t *io;
    ocs_scsi_io_status_e scsi_status;
    uint32_t flags;
    void *arg;
} ocs_ramd_cmd_dataphase_cb_t;

typedef struct {
    ocs_io_t *io;
    ocs_scsi_io_status_e scsi_status;
    uint32_t flags;
    void *arg;
} ocs_ramd_cmd_io_cb_t;

typedef struct {
    void (*fctn)(void *arg);
    void *arg;
} ocs_ramd_cmd_bounce_t;

typedef struct {
    ocs_ramd_cmd_e ramd_cmd_type;
    union {
        ocs_ramd_cmd_recv_cmd_t recv_cmd;
        ocs_ramd_cmd_dataphase_cb_t dataphase_cb;
        ocs_ramd_cmd_io_cb_t io_cb;
        ocs_ramd_cmd_bounce_t bounce;
    } ramd_cmd;
} ocs_ramd_cmd_t;

typedef struct {
    ocs_thread_t thread;
    ocs_cbuf_t *cmd_queue;
    uint32_t cmd_count[OCS_RAMD_CMD_MAX];
    uint8_t started:1;
} ocs_ramd_thread_t;


extern int32_t ocs_ramd_start_threads(uint32_t threading_mode, uint32_t thread_cmds);
extern void ocs_ramd_stop_threads(void);
extern void ocs_ramd_thread_ddump(ocs_textbuf_t *textbuf);
extern void ocs_ramd_tgt_bounce(void (*fctn)(void *arg), void *arg, uint32_t s_id, uint32_t d_id, uint32_t ox_id);
extern uint32_t ocs_ramd_get_enable_ramd_threading(void);
#endif // __OCS_RAMD_THREAD_H__