mali_kbase_js_defs.h

/*
 *
 * (C) COPYRIGHT 2011-2016 ARM Limited. All rights reserved.
 *
 * This program is free software and is provided to you under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation, and any use by you of this program is subject to the terms
 * of such GNU licence.
 *
 * A copy of the licence is included with the program, and can also be obtained
 * from Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 *
 */





#ifndef _KBASE_JS_DEFS_H_
#define _KBASE_JS_DEFS_H_

/* Forward decls */
struct kbase_device;
struct kbase_jd_atom;


typedef u32 kbase_context_flags;

struct kbasep_atom_req {
    base_jd_core_req core_req;
    kbase_context_flags ctx_req;
    u32 device_nr;
};

typedef void (*kbasep_js_ctx_job_cb)(struct kbase_device *kbdev, struct kbase_jd_atom *katom);

#define KBASE_JS_MAX_JOB_SUBMIT_PER_SLOT_PER_IRQ 2

#define KBASE_JS_IRQ_THROTTLE_TIME_US 20

enum kbasep_js_ctx_attr {
    KBASEP_JS_CTX_ATTR_COMPUTE,

    KBASEP_JS_CTX_ATTR_NON_COMPUTE,

    KBASEP_JS_CTX_ATTR_COMPUTE_ALL_CORES,

    KBASEP_JS_CTX_ATTR_COUNT
};

enum {
    KBASE_JS_ATOM_DONE_START_NEW_ATOMS = (1u << 0),
    KBASE_JS_ATOM_DONE_EVICTED_FROM_NEXT = (1u << 1)
};

typedef u32 kbasep_js_atom_done_code;

struct kbasep_js_per_as_data {
    int as_busy_refcount;

    struct kbase_context *kctx;
};

struct kbasep_js_device_data {
    /* Sub-structure to collect together Job Scheduling data used in IRQ
     * context. The hwaccess_lock must be held when accessing. */
    struct runpool_irq {
        u16 submit_allowed;

        s8 ctx_attr_ref_count[KBASEP_JS_CTX_ATTR_COUNT];

        struct kbasep_js_per_as_data per_as_data[BASE_MAX_NR_AS];

        /*
         * Affinity management and tracking
         */
        u64 slot_affinities[BASE_JM_MAX_NR_SLOTS];
        s8 slot_affinity_refcount[BASE_JM_MAX_NR_SLOTS][64];
    } runpool_irq;

    struct mutex runpool_mutex;

    struct mutex queue_mutex;

    struct semaphore schedule_sem;

    struct list_head ctx_list_pullable[BASE_JM_MAX_NR_SLOTS];
    struct list_head ctx_list_unpullable[BASE_JM_MAX_NR_SLOTS];

    u16 as_free;                
    s8 nr_user_contexts_running;
    s8 nr_all_contexts_running;

    base_jd_core_req js_reqs[BASE_JM_MAX_NR_SLOTS];

    u32 scheduling_period_ns;    /*< Value for JS_SCHEDULING_PERIOD_NS */
    u32 soft_stop_ticks;         /*< Value for JS_SOFT_STOP_TICKS */
    u32 soft_stop_ticks_cl;      /*< Value for JS_SOFT_STOP_TICKS_CL */
    u32 hard_stop_ticks_ss;      /*< Value for JS_HARD_STOP_TICKS_SS */
    u32 hard_stop_ticks_cl;      /*< Value for JS_HARD_STOP_TICKS_CL */
    u32 hard_stop_ticks_dumping; /*< Value for JS_HARD_STOP_TICKS_DUMPING */
    u32 gpu_reset_ticks_ss;      /*< Value for JS_RESET_TICKS_SS */
    u32 gpu_reset_ticks_cl;      /*< Value for JS_RESET_TICKS_CL */
    u32 gpu_reset_ticks_dumping; /*< Value for JS_RESET_TICKS_DUMPING */
    u32 ctx_timeslice_ns;        
    atomic_t soft_job_timeout_ms;

    struct list_head suspended_soft_jobs_list;

#ifdef CONFIG_MALI_DEBUG
    /* Support soft-stop on a single context */
    bool softstop_always;
#endif              /* CONFIG_MALI_DEBUG */

    int init_status;

    /* Number of contexts that can currently be pulled from */
    u32 nr_contexts_pullable;

    /* Number of contexts that can either be pulled from or are currently
     * running */
    atomic_t nr_contexts_runnable;
};

struct kbasep_js_kctx_info {

    struct kbase_jsctx {
        struct mutex jsctx_mutex;           
        u32 nr_jobs;

        u32 ctx_attr_ref_count[KBASEP_JS_CTX_ATTR_COUNT];

        wait_queue_head_t is_scheduled_wait;

        struct list_head ctx_list_entry[BASE_JM_MAX_NR_SLOTS];
    } ctx;

    /* The initalized-flag is placed at the end, to avoid cache-pollution (we should
     * only be using this during init/term paths) */
    int init_status;
};

struct kbasep_js_atom_retained_state {
    enum base_jd_event_code event_code;
    base_jd_core_req core_req;
    /* priority */
    int sched_priority;
    int retry_submit_on_slot;
    /* Core group atom was executed on */
    u32 device_nr;

};

#define KBASEP_JS_RETRY_SUBMIT_SLOT_INVALID (-1)

#define KBASEP_JS_ATOM_RETAINED_STATE_CORE_REQ_INVALID BASE_JD_REQ_DEP

#define KBASEP_JS_TICK_RESOLUTION_US 1

/*
 * Internal atom priority defines for kbase_jd_atom::sched_prio
 */
enum {
    KBASE_JS_ATOM_SCHED_PRIO_HIGH = 0,
    KBASE_JS_ATOM_SCHED_PRIO_MED,
    KBASE_JS_ATOM_SCHED_PRIO_LOW,
    KBASE_JS_ATOM_SCHED_PRIO_COUNT,
};

/* Invalid priority for kbase_jd_atom::sched_prio */
#define KBASE_JS_ATOM_SCHED_PRIO_INVALID -1

/* Default priority in the case of contexts with no atoms, or being lenient
 * about invalid priorities from userspace */
#define KBASE_JS_ATOM_SCHED_PRIO_DEFAULT KBASE_JS_ATOM_SCHED_PRIO_MED
/* end group kbase_js *//* end group base_kbase_api *//* end group base_api */

#endif              /* _KBASE_JS_DEFS_H_ */