/* SPDX-License-Identifier: GPL-2.0+ */ 
 | 
// Copyright 2017 IBM Corp. 
 | 
#ifndef _OCXL_INTERNAL_H_ 
 | 
#define _OCXL_INTERNAL_H_ 
 | 
  
 | 
#include <linux/pci.h> 
 | 
#include <linux/cdev.h> 
 | 
#include <linux/list.h> 
 | 
#include <misc/ocxl.h> 
 | 
  
 | 
#define MAX_IRQ_PER_LINK    2000 
 | 
#define MAX_IRQ_PER_CONTEXT    MAX_IRQ_PER_LINK 
 | 
  
 | 
extern struct pci_driver ocxl_pci_driver; 
 | 
  
 | 
struct ocxl_fn { 
 | 
    struct device dev; 
 | 
    int bar_used[3]; 
 | 
    struct ocxl_fn_config config; 
 | 
    struct list_head afu_list; 
 | 
    int pasid_base; 
 | 
    int actag_base; 
 | 
    int actag_enabled; 
 | 
    int actag_supported; 
 | 
    struct list_head pasid_list; 
 | 
    struct list_head actag_list; 
 | 
    void *link; 
 | 
}; 
 | 
  
 | 
struct ocxl_file_info { 
 | 
    struct ocxl_afu *afu; 
 | 
    struct device dev; 
 | 
    struct cdev cdev; 
 | 
    struct bin_attribute attr_global_mmio; 
 | 
}; 
 | 
  
 | 
struct ocxl_afu { 
 | 
    struct kref kref; 
 | 
    struct ocxl_fn *fn; 
 | 
    struct list_head list; 
 | 
    struct ocxl_afu_config config; 
 | 
    int pasid_base; 
 | 
    int pasid_count; /* opened contexts */ 
 | 
    int pasid_max; /* maximum number of contexts */ 
 | 
    int actag_base; 
 | 
    int actag_enabled; 
 | 
    struct mutex contexts_lock; 
 | 
    struct idr contexts_idr; 
 | 
    struct mutex afu_control_lock; 
 | 
    u64 global_mmio_start; 
 | 
    u64 irq_base_offset; 
 | 
    void __iomem *global_mmio_ptr; 
 | 
    u64 pp_mmio_start; 
 | 
    void *private; 
 | 
}; 
 | 
  
 | 
enum ocxl_context_status { 
 | 
    CLOSED, 
 | 
    OPENED, 
 | 
    ATTACHED, 
 | 
}; 
 | 
  
 | 
// Contains metadata about a translation fault 
 | 
struct ocxl_xsl_error { 
 | 
    u64 addr; // The address that triggered the fault 
 | 
    u64 dsisr; // the value of the dsisr register 
 | 
    u64 count; // The number of times this fault has been triggered 
 | 
}; 
 | 
  
 | 
struct ocxl_context { 
 | 
    struct ocxl_afu *afu; 
 | 
    int pasid; 
 | 
    struct mutex status_mutex; 
 | 
    enum ocxl_context_status status; 
 | 
    struct address_space *mapping; 
 | 
    struct mutex mapping_lock; 
 | 
    wait_queue_head_t events_wq; 
 | 
    struct mutex xsl_error_lock; 
 | 
    struct ocxl_xsl_error xsl_error; 
 | 
    struct mutex irq_lock; 
 | 
    struct idr irq_idr; 
 | 
    u16 tidr; // Thread ID used for P9 wait implementation 
 | 
}; 
 | 
  
 | 
struct ocxl_process_element { 
 | 
    __be64 config_state; 
 | 
    __be32 reserved1[11]; 
 | 
    __be32 lpid; 
 | 
    __be32 tid; 
 | 
    __be32 pid; 
 | 
    __be32 reserved2[10]; 
 | 
    __be64 amr; 
 | 
    __be32 reserved3[3]; 
 | 
    __be32 software_state; 
 | 
}; 
 | 
  
 | 
int ocxl_create_cdev(struct ocxl_afu *afu); 
 | 
void ocxl_destroy_cdev(struct ocxl_afu *afu); 
 | 
int ocxl_file_register_afu(struct ocxl_afu *afu); 
 | 
void ocxl_file_unregister_afu(struct ocxl_afu *afu); 
 | 
  
 | 
int ocxl_file_init(void); 
 | 
void ocxl_file_exit(void); 
 | 
  
 | 
int ocxl_pasid_afu_alloc(struct ocxl_fn *fn, u32 size); 
 | 
void ocxl_pasid_afu_free(struct ocxl_fn *fn, u32 start, u32 size); 
 | 
int ocxl_actag_afu_alloc(struct ocxl_fn *fn, u32 size); 
 | 
void ocxl_actag_afu_free(struct ocxl_fn *fn, u32 start, u32 size); 
 | 
  
 | 
/* 
 | 
 * Get the max PASID value that can be used by the function 
 | 
 */ 
 | 
int ocxl_config_get_pasid_info(struct pci_dev *dev, int *count); 
 | 
  
 | 
/* 
 | 
 * Control whether the FPGA is reloaded on a link reset 
 | 
 */ 
 | 
int ocxl_config_get_reset_reload(struct pci_dev *dev, int *val); 
 | 
int ocxl_config_set_reset_reload(struct pci_dev *dev, int val); 
 | 
  
 | 
/* 
 | 
 * Check if an AFU index is valid for the given function. 
 | 
 * 
 | 
 * AFU indexes can be sparse, so a driver should check all indexes up 
 | 
 * to the maximum found in the function description 
 | 
 */ 
 | 
int ocxl_config_check_afu_index(struct pci_dev *dev, 
 | 
                struct ocxl_fn_config *fn, int afu_idx); 
 | 
  
 | 
/** 
 | 
 * ocxl_link_update_pe() - Update values within a Process Element 
 | 
 * @link_handle: the link handle associated with the process element 
 | 
 * @pasid: the PASID for the AFU context 
 | 
 * @tid: the new thread id for the process element 
 | 
 * 
 | 
 * Returns 0 on success 
 | 
 */ 
 | 
int ocxl_link_update_pe(void *link_handle, int pasid, __u16 tid); 
 | 
  
 | 
int ocxl_context_mmap(struct ocxl_context *ctx, 
 | 
            struct vm_area_struct *vma); 
 | 
void ocxl_context_detach_all(struct ocxl_afu *afu); 
 | 
  
 | 
int ocxl_sysfs_register_afu(struct ocxl_file_info *info); 
 | 
void ocxl_sysfs_unregister_afu(struct ocxl_file_info *info); 
 | 
  
 | 
int ocxl_irq_offset_to_id(struct ocxl_context *ctx, u64 offset); 
 | 
u64 ocxl_irq_id_to_offset(struct ocxl_context *ctx, int irq_id); 
 | 
void ocxl_afu_irq_free_all(struct ocxl_context *ctx); 
 | 
  
 | 
#endif /* _OCXL_INTERNAL_H_ */ 
 |