123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251 |
- /*
- * Copyright (c) 2017 Cadence Design Systems, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining
- * a copy of this software and associated documentation files (the
- * "Software"), to deal in the Software without restriction, including
- * without limitation the rights to use, copy, modify, merge, publish,
- * distribute, sublicense, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to
- * the following conditions:
- *
- * The above copyright notice and this permission notice shall be included
- * in all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
- * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
- * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
- * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * Alternatively you can use and distribute this file under the terms of
- * the GNU General Public License version 2 or later.
- */
- /*!
- * \file xrp_hw.h
- * \brief Interface between generic and HW-specific kernel drivers.
- */
- #ifndef _XRP_HW
- #define _XRP_HW
- #include <linux/irqreturn.h>
- #include <linux/platform_device.h>
- #include <linux/types.h>
- struct xvp;
- /*!
- * Hardware-specific operation entry points.
- * Hardware-specific driver passes a pointer to this structure to xrp_init
- * at initialization time.
- */
- struct xrp_hw_ops {
- /*!
- * Enable power/clock, but keep the core stalled.
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- */
- int (*enable)(void *hw_arg);
- /*!
- * Diable power/clock.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- */
- void (*disable)(void *hw_arg);
- /*!
- * Reset the core.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- */
- void (*reset)(void *hw_arg);
- /*!
- * Unstall the core.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- */
- void (*release)(void *hw_arg);
- /*!
- * Stall the core.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- */
- void (*halt)(void *hw_arg);
- /*! Get HW-specific data to pass to the DSP on synchronization
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- * \param sz: return size of sync data here
- * \return a buffer allocated with kmalloc that the caller will free
- */
- void *(*get_hw_sync_data)(void *hw_arg, size_t *sz);
- /*!
- * Send IRQ to the core.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- */
- void (*send_irq)(void *hw_arg);
- /*!
- * Check whether region of physical memory may be handled by
- * dma_sync_* operations
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- */
- bool (*cacheable)(void *hw_arg, unsigned long pfn, unsigned long n_pages);
- /*!
- * Synchronize region of memory for DSP access.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- * \param flags: XRP_FLAG_{READ,WRITE,READWRITE}
- */
- void (*dma_sync_for_device)(void *hw_arg,
- void *vaddr, phys_addr_t paddr,
- unsigned long sz, unsigned flags);
- /*!
- * Synchronize region of memory for host access.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- * \param flags: XRP_FLAG_{READ,WRITE,READWRITE}
- */
- void (*dma_sync_for_cpu)(void *hw_arg,
- void *vaddr, phys_addr_t paddr,
- unsigned long sz, unsigned flags);
- /*!
- * memcpy data/code to device-specific memory.
- */
- void (*memcpy_tohw)(volatile void __iomem *dst, const void *src, size_t sz);
- /*!
- * memset device-specific memory.
- */
- void (*memset_hw)(volatile void __iomem *dst, int c, size_t sz);
- /*!
- * Check DSP status.
- *
- * \param hw_arg: opaque parameter passed to xrp_init at initialization
- * time
- * \return whether the core has crashed and needs to be restarted
- */
- bool (*panic_check)(void *hw_arg);
- phys_addr_t (*get_base_mimo)(void *hw_arg);
- void (*update_device_base)(void *hw_arg,phys_addr_t addr);
- void (*set_reset_vector)(void *hw_arg,u32 addr);
- void (*clear_hw)(void *hw_arg);
- };
- enum xrp_init_flags {
- /*! Use interrupts in DSP->host communication */
- XRP_INIT_USE_HOST_IRQ = 0x1,
- };
- /*!
- * Initialize generic XRP kernel driver from cdns,xrp-compatible device
- * tree node.
- *
- * \param pdev: pointer to platform device associated with the XRP device
- * instance
- * \param flags: initialization flags
- * \param hw: pointer to xrp_hw_ops structeure for this device
- * \param hw_arg: opaque pointer passed back to hw-specific functions
- * \return error code or pointer to struct xvp, use IS_ERR_VALUE and ERR_PTR
- */
- long xrp_init(struct platform_device *pdev, enum xrp_init_flags flags,
- const struct xrp_hw_ops *hw, void *hw_arg,int mem_idx);
- /*!
- * Initialize generic XRP kernel driver from cdns,xrp,v1-compatible device
- * tree node.
- *
- * \param pdev: pointer to platform device associated with the XRP device
- * instance
- * \param flags: initialization flags
- * \param hw: pointer to xrp_hw_ops structeure for this device
- * \param hw_arg: opaque pointer passed back to hw-specific functions
- * \return error code or pointer to struct xvp, use IS_ERR_VALUE and ERR_PTR
- */
- long xrp_init_v1(struct platform_device *pdev, enum xrp_init_flags flags,
- const struct xrp_hw_ops *hw, void *hw_arg,int mem_idx);
- /*!
- * Initialize generic XRP kernel driver from cdns,xrp,cma-compatible device
- * tree node.
- *
- * \param pdev: pointer to platform device associated with the XRP device
- * instance
- * \param flags: initialization flags
- * \param hw: pointer to xrp_hw_ops structeure for this device
- * \param hw_arg: opaque pointer passed back to hw-specific functions
- * \return error code or pointer to struct xvp, use IS_ERR_VALUE and ERR_PTR
- */
- long xrp_init_cma(struct platform_device *pdev, enum xrp_init_flags flags,
- const struct xrp_hw_ops *hw, void *hw_arg,int mem_idx);
- /*!
- * Deinitialize generic XRP kernel driver.
- *
- * \param pdev: pointer to platform device associated with the XRP device
- * instance
- * \return 0 on success, negative error code otherwise
- */
- int xrp_deinit(struct platform_device *pdev);
- /*!
- * Deinitialize generic XRP kernel driver.
- *
- * \param pdev: pointer to platform device associated with the XRP device
- * instance
- * \param hw_arg: optional pointer to opaque pointer where generic XRP driver
- * returns hw_arg that was associated with the pdev at xrp_init
- * time
- * \return 0 on success, negative error code otherwise
- */
- int xrp_deinit_hw(struct platform_device *pdev, void **hw_arg);
- /*!
- * Notify generic XRP driver of possible IRQ from the DSP.
- *
- * \param irq: IRQ number
- * \param xvp: pointer to struct xvp returned from xrp_init* call
- * \return whether IRQ was recognized and handled
- */
- irqreturn_t xrp_irq_handler(int irq, struct xvp *xvp);
- /*!
- * Resume generic XRP operation of the device dev.
- *
- * \param dev: device which operation shall be resumed
- * \return 0 on success, negative error code otherwise
- */
- int xrp_runtime_resume(struct device *dev);
- /*!
- * Suspend generic XRP operation of the device dev.
- *
- * \param dev: device which operation shall be suspended
- * \return 0 on success, negative error code otherwise
- */
- int xrp_runtime_suspend(struct device *dev);
- int xrp_set_reset_reg(int dsp_id);
- #endif
|