/********************************************************************** * Author: Cavium, Inc. * * Contact: [email protected] * Please include "LiquidIO" in the subject. * * Copyright (c) 2003-2016 Cavium, Inc. * * This file is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License, Version 2, as * published by the Free Software Foundation. * * This file is distributed in the hope that it will be useful, but * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or * NONINFRINGEMENT. See the GNU General Public License for more * details. **********************************************************************/ /*! \file response_manager.h * \brief Host Driver: Response queues for host instructions. */ #ifndef __RESPONSE_MANAGER_H__ #define __RESPONSE_MANAGER_H__ /** Maximum ordered requests to process in every invocation of * lio_process_ordered_list(). The function will continue to process requests * as long as it can find one that has finished processing. If it keeps * finding requests that have completed, the function can run for ever. The * value defined here sets an upper limit on the number of requests it can * process before it returns control to the poll thread. */ #define MAX_ORD_REQS_TO_PROCESS … /** Head of a response list. There are several response lists in the * system. One for each response order- Unordered, ordered * and 1 for noresponse entries on each instruction queue. */ struct octeon_response_list { … }; /** The type of response list. */ enum { … }; /** Response Order values for a Octeon Request. */ enum { … }; /** Error codes used in Octeon Host-Core communication. * * 31 16 15 0 * --------------------------------- * | | | * --------------------------------- * Error codes are 32-bit wide. The upper 16-bits, called Major Error Number, * are reserved to identify the group to which the error code belongs. The * lower 16-bits, called Minor Error Number, carry the actual code. * * So error codes are (MAJOR NUMBER << 16)| MINOR_NUMBER. */ /*------------ Error codes used by host driver -----------------*/ #define DRIVER_MAJOR_ERROR_CODE … /*------ Error codes used by firmware (bits 15..0 set by firmware */ #define FIRMWARE_MAJOR_ERROR_CODE … /** A value of 0x00000000 indicates no error i.e. success */ #define DRIVER_ERROR_NONE … #define DRIVER_ERROR_REQ_PENDING … #define DRIVER_ERROR_REQ_TIMEOUT … #define DRIVER_ERROR_REQ_EINTR … #define DRIVER_ERROR_REQ_ENXIO … #define DRIVER_ERROR_REQ_ENOMEM … #define DRIVER_ERROR_REQ_EINVAL … #define DRIVER_ERROR_REQ_FAILED … /** Status for a request. * If a request is not queued to Octeon by the driver, the driver returns * an error condition that's describe by one of the OCTEON_REQ_ERR_* value * below. If the request is successfully queued, the driver will return * a OCTEON_REQUEST_PENDING status. OCTEON_REQUEST_TIMEOUT and * OCTEON_REQUEST_INTERRUPTED are only returned by the driver if the * response for request failed to arrive before a time-out period or if * the request processing * got interrupted due to a signal respectively. */ enum { … }; #define FIRMWARE_STATUS_CODE(status) … /** Initialize the response lists. The number of response lists to create is * given by count. * @param octeon_dev - the octeon device structure. */ int octeon_setup_response_list(struct octeon_device *octeon_dev); void octeon_delete_response_list(struct octeon_device *octeon_dev); /** Check the status of first entry in the ordered list. If the instruction at * that entry finished processing or has timed-out, the entry is cleaned. * @param octeon_dev - the octeon device structure. * @param force_quit - the request is forced to timeout if this is 1 * @return 1 if the ordered list is empty, 0 otherwise. */ int lio_process_ordered_list(struct octeon_device *octeon_dev, u32 force_quit); #endif
Codebase Browser
linux