| blob | 397081d320b1952c2677b8bceefc6c69fb402f39 |
1 /*
2 * Universal Flash Storage Host controller driver Core
3 *
4 * This code is based on drivers/scsi/ufs/ufshcd.c
5 * Copyright (C) 2011-2013 Samsung India Software Operations
6 * Copyright (c) 2013-2016, The Linux Foundation. All rights reserved.
7 *
8 * Authors:
9 * Santosh Yaraganavi <santosh.sy@samsung.com>
10 * Vinayak Holikatti <h.vinayak@samsung.com>
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
16 * See the COPYING file in the top-level directory or visit
17 * <http://www.gnu.org/licenses/gpl-2.0.html>
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * This program is provided "AS IS" and "WITH ALL FAULTS" and
25 * without warranty of any kind. You are solely responsible for
26 * determining the appropriateness of using and distributing
27 * the program and assume all risks associated with your exercise
28 * of rights with respect to the program, including but not limited
29 * to infringement of third party rights, the risks and costs of
30 * program errors, damage to or loss of data, programs or equipment,
31 * and unavailability or interruption of operations. Under no
32 * circumstances will the contributor of this Program be liable for
33 * any damages of any kind arising from your use or distribution of
34 * this program.
35 *
36 * The Linux Foundation chooses to take subject only to the GPLv2
37 * license terms, and distributes only under these terms.
38 */
40 #include <linux/async.h>
41 #include <linux/devfreq.h>
42 #include <linux/nls.h>
43 #include <linux/of.h>
44 #include <linux/bitfield.h>
50 #define CREATE_TRACE_POINTS
51 #include <trace/events/ufs.h>
53 #define UFSHCD_REQ_SENSE_SIZE 18
55 #define UFSHCD_ENABLE_INTRS (UTP_TRANSFER_REQ_COMPL |\
56 UTP_TASK_REQ_COMPL |\
57 UFSHCD_ERROR_MASK)
58 /* UIC command timeout, unit: ms */
59 #define UIC_CMD_TIMEOUT 500
61 /* NOP OUT retries waiting for NOP IN response */
62 #define NOP_OUT_RETRIES 10
63 /* Timeout after 30 msecs if NOP OUT hangs without response */
66 /* Query request retries */
67 #define QUERY_REQ_RETRIES 3
68 /* Query request timeout */
71 /* Task management command timeout */
74 /* maximum number of retries for a general UIC command */
75 #define UFS_UIC_COMMAND_RETRIES 3
77 /* maximum number of link-startup retries */
78 #define DME_LINKSTARTUP_RETRIES 3
80 /* Maximum retries for Hibern8 enter */
81 #define UIC_HIBERN8_ENTER_RETRIES 3
83 /* maximum number of reset retries before giving up */
84 #define MAX_HOST_RESET_RETRIES 5
86 /* Expose the flag value from utp_upiu_query.value */
87 #define MASK_QUERY_UPIU_FLAG_LOC 0xFF
89 /* Interrupt aggregation default timeout, unit: 40us */
90 #define INT_AGGR_DEF_TO 0x02
92 #define ufshcd_toggle_vreg(_dev, _vreg, _on) \
93 ({ \
94 int _ret; \
95 if (_on) \
96 _ret = ufshcd_enable_vreg(_dev, _vreg); \
97 else \
98 _ret = ufshcd_disable_vreg(_dev, _vreg); \
99 _ret; \
100 })
102 #define ufshcd_hex_dump(prefix_str, buf, len) \
103 print_hex_dump(KERN_ERR, prefix_str, DUMP_PREFIX_OFFSET, 16, 4, buf, len, false)
110 };
112 /* UFSHCD states */
114 UFSHCD_STATE_RESET,
115 UFSHCD_STATE_ERROR,
116 UFSHCD_STATE_OPERATIONAL,
117 UFSHCD_STATE_EH_SCHEDULED,
118 };
120 /* UFSHCD error handling flags */
123 };
125 /* UFSHCD UIC layer error flags */
133 };
135 #define ufshcd_set_eh_in_progress(h) \
136 ((h)->eh_flags |= UFSHCD_EH_IN_PROGRESS)
137 #define ufshcd_eh_in_progress(h) \
138 ((h)->eh_flags & UFSHCD_EH_IN_PROGRESS)
139 #define ufshcd_clear_eh_in_progress(h) \
140 ((h)->eh_flags &= ~UFSHCD_EH_IN_PROGRESS)
142 #define ufshcd_set_ufs_dev_active(h) \
143 ((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE)
144 #define ufshcd_set_ufs_dev_sleep(h) \
145 ((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE)
146 #define ufshcd_set_ufs_dev_poweroff(h) \
147 ((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE)
148 #define ufshcd_is_ufs_dev_active(h) \
149 ((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE)
150 #define ufshcd_is_ufs_dev_sleep(h) \
151 ((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE)
152 #define ufshcd_is_ufs_dev_poweroff(h) \
153 ((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE)
162 };
166 {
168 }
172 {
174 }
179 {
186 }
188 /* if no match found, return the level 0 */
190 }
193 /* UFS cards deviations table */
195 UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM),
198 UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS),
200 UFS_DEVICE_NO_FASTAUTO),
202 UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE),
204 UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM),
206 UFS_DEVICE_QUIRK_PA_TACTIVATE),
208 UFS_DEVICE_QUIRK_PA_TACTIVATE),
211 UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME),
213 END_FIX
214 };
239 {
241 }
244 {
249 hba);
254 }
257 }
260 {
264 }
265 }
268 {
271 }
274 {
277 }
279 /* replace non-printable or non-ASCII characters with spaces */
281 {
287 }
291 {
295 }
299 {
303 }
307 {
316 }
320 {
327 /* trace UPIU also */
338 /*
339 * Currently we only fully trace read(10) and write(10)
340 * commands
341 */
343 lba =
347 }
348 }
354 }
357 {
369 }
370 }
374 {
384 }
385 }
388 {
389 /*
390 * hex_dump reads its data without the readl macro. This might
391 * cause inconsistency issues on some platform, as the printed
392 * values may be from cache and not the most recent value.
393 * To know whether you are looking at an un-cached version verify
394 * that IORESOURCE_MEM flag is on when xxx_get_resource() is invoked
395 * during platform/pci probe function.
396 */
418 }
420 static
422 {
459 }
460 }
463 {
473 tag);
477 tag);
480 }
481 }
484 {
503 }
505 /**
506 * ufshcd_print_pwr_info - print power params as saved in hba
507 * power info
508 * @hba: per-adapter instance
509 */
511 {
520 };
523 __func__,
529 }
531 /*
532 * ufshcd_wait_for_register - wait for register value to change
533 * @hba - per-adapter interface
534 * @reg - mmio register offset
535 * @mask - mask to apply to read register value
536 * @val - wait condition
537 * @interval_us - polling interval in microsecs
538 * @timeout_ms - timeout in millisecs
539 * @can_sleep - perform sleep or just spin
540 *
541 * Returns -ETIMEDOUT on error, zero on success
542 */
546 {
550 /* ignore bits that we don't intend to wait on */
556 else
562 }
563 }
566 }
568 /**
569 * ufshcd_get_intr_mask - Get the interrupt bit mask
570 * @hba: Pointer to adapter instance
571 *
572 * Returns interrupt bit mask per version
573 */
575 {
590 }
593 }
595 /**
596 * ufshcd_get_ufs_version - Get the UFS version supported by the HBA
597 * @hba: Pointer to adapter instance
598 *
599 * Returns UFSHCI version supported by the controller
600 */
602 {
607 }
609 /**
610 * ufshcd_is_device_present - Check if any device connected to
611 * the host controller
612 * @hba: pointer to adapter instance
613 *
614 * Returns true if device present, false if no device detected
615 */
617 {
620 }
622 /**
623 * ufshcd_get_tr_ocs - Get the UTRD Overall Command Status
624 * @lrbp: pointer to local command reference block
625 *
626 * This function is used to get the OCS field from UTRD
627 * Returns the OCS field in the UTRD
628 */
630 {
632 }
634 /**
635 * ufshcd_get_tmr_ocs - Get the UTMRD Overall Command Status
636 * @task_req_descp: pointer to utp_task_req_desc structure
637 *
638 * This function is used to get the OCS field from UTMRD
639 * Returns the OCS field in the UTMRD
640 */
643 {
645 }
647 /**
648 * ufshcd_get_tm_free_slot - get a free slot for task management request
649 * @hba: per adapter instance
650 * @free_slot: pointer to variable with available slot value
651 *
652 * Get a free tag and lock it until ufshcd_put_tm_slot() is called.
653 * Returns 0 if free slot is not available, else return 1 with tag value
654 * in @free_slot.
655 */
657 {
672 out:
674 }
677 {
679 }
681 /**
682 * ufshcd_utrl_clear - Clear a bit in UTRLCLR register
683 * @hba: per adapter instance
684 * @pos: position of the bit to be cleared
685 */
687 {
690 else
692 REG_UTP_TRANSFER_REQ_LIST_CLEAR);
693 }
695 /**
696 * ufshcd_utmrl_clear - Clear a bit in UTRMLCLR register
697 * @hba: per adapter instance
698 * @pos: position of the bit to be cleared
699 */
701 {
704 else
706 }
708 /**
709 * ufshcd_outstanding_req_clear - Clear a bit in outstanding request field
710 * @hba: per adapter instance
711 * @tag: position of the bit to be cleared
712 */
714 {
716 }
718 /**
719 * ufshcd_get_lists_status - Check UCRDY, UTRLRDY and UTMRLRDY
720 * @reg: Register value of host controller status
721 *
722 * Returns integer, 0 on Success and positive value if failed
723 */
725 {
727 }
729 /**
730 * ufshcd_get_uic_cmd_result - Get the UIC command result
731 * @hba: Pointer to adapter instance
732 *
733 * This function gets the result of UIC command completion
734 * Returns 0 on success, non zero value on error
735 */
737 {
739 MASK_UIC_COMMAND_RESULT;
740 }
742 /**
743 * ufshcd_get_dme_attr_val - Get the value of attribute returned by UIC command
744 * @hba: Pointer to adapter instance
745 *
746 * This function gets UIC command argument3
747 * Returns 0 on success, non zero value on error
748 */
750 {
752 }
754 /**
755 * ufshcd_get_req_rsp - returns the TR response transaction type
756 * @ucd_rsp_ptr: pointer to response UPIU
757 */
760 {
762 }
764 /**
765 * ufshcd_get_rsp_upiu_result - Get the result from response UPIU
766 * @ucd_rsp_ptr: pointer to response UPIU
767 *
768 * This function gets the response status and scsi_status from response UPIU
769 * Returns the response result code.
770 */
773 {
775 }
777 /*
778 * ufshcd_get_rsp_upiu_data_seg_len - Get the data segment length
779 * from response UPIU
780 * @ucd_rsp_ptr: pointer to response UPIU
781 *
782 * Return the data segment length.
783 */
786 {
788 MASK_RSP_UPIU_DATA_SEG_LEN;
789 }
791 /**
792 * ufshcd_is_exception_event - Check if the device raised an exception event
793 * @ucd_rsp_ptr: pointer to response UPIU
794 *
795 * The function checks if the device raised an exception event indicated in
796 * the Device Information field of response UPIU.
797 *
798 * Returns true if exception is raised, false otherwise.
799 */
801 {
804 }
806 /**
807 * ufshcd_reset_intr_aggr - Reset interrupt aggregation values.
808 * @hba: per adapter instance
809 */
812 {
814 INT_AGGR_COUNTER_AND_TIMER_RESET,
815 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
816 }
818 /**
819 * ufshcd_config_intr_aggr - Configure interrupt aggregation values.
820 * @hba: per adapter instance
821 * @cnt: Interrupt aggregation counter threshold
822 * @tmout: Interrupt aggregation timeout value
823 */
826 {
830 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
831 }
833 /**
834 * ufshcd_disable_intr_aggr - Disables interrupt aggregation.
835 * @hba: per adapter instance
836 */
838 {
840 }
842 /**
843 * ufshcd_enable_run_stop_reg - Enable run-stop registers,
844 * When run-stop registers are set to 1, it indicates the
845 * host controller that it can process the requests
846 * @hba: per adapter instance
847 */
849 {
851 REG_UTP_TASK_REQ_LIST_RUN_STOP);
853 REG_UTP_TRANSFER_REQ_LIST_RUN_STOP);
854 }
856 /**
857 * ufshcd_hba_start - Start controller initialization sequence
858 * @hba: per adapter instance
859 */
861 {
863 }
865 /**
866 * ufshcd_is_hba_active - Get controller state
867 * @hba: per adapter instance
868 *
869 * Returns false if controller is active, true otherwise
870 */
872 {
875 }
878 {
879 /* HCI version 1.0 and 1.1 supports UniPro 1.41 */
883 else
885 }
889 {
890 /*
891 * If both host and device support UniPro ver1.6 or later, PA layer
892 * parameters tuning happens during link startup itself.
893 *
894 * We can manually tune PA layer parameters if either host or device
895 * doesn't support UniPro ver 1.6 or later. But to keep manual tuning
896 * logic simple, we will only do manual tuning if local unipro version
897 * doesn't support ver1.6 or later.
898 */
901 else
903 }
906 {
933 }
952 }
958 }
959 }
962 }
966 out:
972 }
974 /**
975 * ufshcd_is_devfreq_scaling_required - check if scaling is required or not
976 * @hba: per adapter instance
977 * @scale_up: True if scaling up and false if scaling down
978 *
979 * Returns true if scaling is required, false otherwise.
980 */
983 {
1000 }
1001 }
1002 }
1005 }
1008 u64 wait_timeout_us)
1009 {
1012 u32 tm_doorbell;
1013 u32 tr_doorbell;
1015 ktime_t start;
1019 /*
1020 * Wait for all the outstanding tasks/transfer requests.
1021 * Verify by checking the doorbell registers are clear.
1022 */
1028 }
1037 }
1042 wait_timeout_us) {
1044 /*
1045 * We might have scheduled out for long time so make
1046 * sure to check if doorbells are cleared by this time
1047 * or not.
1048 */
1050 }
1059 }
1060 out:
1064 }
1066 /**
1067 * ufshcd_scale_gear - scale up/down UFS gear
1068 * @hba: per adapter instance
1069 * @scale_up: True for scaling up gear and false for scaling down
1070 *
1071 * Returns 0 for success,
1072 * Returns -EBUSY if scaling can't happen at this time
1073 * Returns non-zero for any other errors
1074 */
1076 {
1077 #define UFS_MIN_GEAR_TO_SCALE_DOWN UFS_HS_G1
1090 /* save the current power mode */
1095 /* scale down gear */
1098 }
1099 }
1101 /* check if the power mode needs to be changed or not? */
1111 }
1114 {
1117 /*
1118 * make sure that there are no outstanding requests when
1119 * clock scaling is in progress
1120 */
1127 }
1130 }
1133 {
1136 }
1138 /**
1139 * ufshcd_devfreq_scale - scale up/down UFS clocks and gear
1140 * @hba: per adapter instance
1141 * @scale_up: True for scaling up and false for scalin down
1142 *
1143 * Returns 0 for success,
1144 * Returns -EBUSY if scaling can't happen at this time
1145 * Returns non-zero for any other errors
1146 */
1148 {
1151 /* let's not get into low power until clock scaling is completed */
1158 /* scale down the gear before scaling down clocks */
1163 }
1170 }
1172 /* scale up the gear after scaling up clocks */
1178 }
1179 }
1183 out:
1187 }
1190 {
1199 }
1204 }
1207 {
1216 }
1221 }
1225 {
1228 ktime_t start;
1241 }
1249 }
1257 }
1267 out:
1273 }
1278 {
1299 start_window:
1309 }
1312 }
1318 };
1321 {
1327 /* Skip devfreq if we don't have any clocks in the list */
1337 DEVFREQ_GOV_SIMPLE_ONDEMAND,
1338 NULL);
1346 }
1351 }
1354 {
1367 }
1370 {
1377 }
1380 {
1391 }
1396 }
1399 {
1410 }
1415 }
1419 {
1423 }
1427 {
1429 u32 value;
1455 }
1459 out:
1461 }
1464 {
1472 }
1475 {
1487 }
1492 /* Exit from hibern8 */
1494 /* Prevent gating in this path */
1501 else
1503 }
1505 }
1506 unblock_reqs:
1508 }
1510 /**
1511 * ufshcd_hold - Enable clocks that were gated earlier due to ufshcd_release.
1512 * Also, exit from hibern8 mode and set the link as active.
1513 * @hba: per adapter instance
1514 * @async: This indicates whether caller should ungate clocks asynchronously.
1515 */
1517 {
1529 }
1531 start:
1534 /*
1535 * Wait for the ungate work to complete if in progress.
1536 * Though the clocks may be in ON state, the link could
1537 * still be in hibner8 state if hibern8 is allowed
1538 * during clock gating.
1539 * Make sure we exit hibern8 state also in addition to
1540 * clocks being ON.
1541 */
1548 }
1556 }
1557 /*
1558 * If we are here, it means gating work is either done or
1559 * currently running. Hence, fall through to cancel gating
1560 * work and to enable clocks.
1561 */
1569 /*
1570 * fall through to check if we should wait for this
1571 * work to be done or not.
1572 */
1578 }
1582 /* Make sure state is CLKS_ON before returning */
1589 }
1591 out:
1593 }
1597 {
1603 /*
1604 * In case you are here to cancel this work the gating state
1605 * would be marked as REQ_CLKS_ON. In this case save time by
1606 * skipping the gating work and exit after changing the clock
1607 * state to CLKS_ON.
1608 */
1615 }
1625 /* put the link into hibern8 mode before turning off clocks */
1632 }
1634 }
1638 else
1639 /* If link is active, device ref_clk can't be switched off */
1642 /*
1643 * In case you are here to cancel this work the gating state
1644 * would be marked as REQ_CLKS_ON. In this case keep the state
1645 * as REQ_CLKS_ON which would anyway imply that clocks are off
1646 * and a request to turn them on is pending. By doing this way,
1647 * we keep the state machine in tact and this would ultimately
1648 * prevent from doing cancel work multiple times when there are
1649 * new requests arriving before the current cancel work is done.
1650 */
1656 }
1657 rel_lock:
1659 out:
1661 }
1663 /* host lock must be held before calling this variant */
1665 {
1682 }
1685 {
1691 }
1696 {
1700 }
1704 {
1715 }
1719 {
1723 }
1727 {
1730 u32 value;
1745 }
1748 out:
1750 }
1753 {
1766 WQ_MEM_RECLAIM);
1785 }
1788 {
1796 }
1798 /* Must be called with host lock acquired */
1800 {
1820 }
1825 }
1826 }
1829 {
1840 }
1841 }
1842 /**
1843 * ufshcd_send_command - Send SCSI or device management commands
1844 * @hba: per adapter instance
1845 * @task_tag: Task tag of the command
1846 */
1849 {
1855 /* Make sure that doorbell is committed immediately */
1858 }
1860 /**
1861 * ufshcd_copy_sense_data - Copy sense data in case of check condition
1862 * @lrbp: pointer to local reference block
1863 */
1865 {
1877 }
1878 }
1880 /**
1881 * ufshcd_copy_query_response() - Copy the Query Response and the data
1882 * descriptor
1883 * @hba: per adapter instance
1884 * @lrbp: pointer to local reference block
1885 */
1886 static
1888 {
1893 /* Get the descriptor */
1896 GENERAL_UPIU_REQUEST_SIZE;
1897 u16 resp_len;
1898 u16 buf_len;
1900 /* data segment length */
1902 MASK_QUERY_DATA_SEG_LEN;
1910 __func__);
1912 }
1913 }
1916 }
1918 /**
1919 * ufshcd_hba_capabilities - Read controller capabilities
1920 * @hba: per adapter instance
1921 */
1923 {
1926 /* nutrs and nutmrs are 0 based values */
1930 }
1932 /**
1933 * ufshcd_ready_for_uic_cmd - Check if controller is ready
1934 * to accept UIC commands
1935 * @hba: per adapter instance
1936 * Return true on success, else false
1937 */
1939 {
1942 else
1944 }
1946 /**
1947 * ufshcd_get_upmcrs - Get the power mode change request status
1948 * @hba: Pointer to adapter instance
1949 *
1950 * This function gets the UPMCRS field of HCS register
1951 * Returns value of UPMCRS field
1952 */
1954 {
1956 }
1958 /**
1959 * ufshcd_dispatch_uic_cmd - Dispatch UIC commands to unipro layers
1960 * @hba: per adapter instance
1961 * @uic_cmd: UIC command
1962 *
1963 * Mutex must be held.
1964 */
1967 {
1972 /* Write Args */
1977 /* Write UIC Cmd */
1979 REG_UIC_COMMAND);
1980 }
1982 /**
1983 * ufshcd_wait_for_uic_cmd - Wait complectioin of UIC command
1984 * @hba: per adapter instance
1985 * @uic_cmd: UIC command
1986 *
1987 * Must be called with mutex held.
1988 * Returns 0 only if success.
1989 */
1990 static int
1992 {
1999 else
2007 }
2009 /**
2010 * __ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
2011 * @hba: per adapter instance
2012 * @uic_cmd: UIC command
2013 * @completion: initialize the completion only if this is set to true
2014 *
2015 * Identical to ufshcd_send_uic_cmd() expect mutex. Must be called
2016 * with mutex held and host_lock locked.
2017 * Returns 0 only if success.
2018 */
2019 static int
2022 {
2027 }
2035 }
2037 /**
2038 * ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
2039 * @hba: per adapter instance
2040 * @uic_cmd: UIC command
2041 *
2042 * Returns 0 only if success.
2043 */
2044 static int
2046 {
2064 }
2066 /**
2067 * ufshcd_map_sg - Map scatter-gather list to prdt
2068 * @hba: per adapter instance
2069 * @lrbp: pointer to local reference block
2070 *
2071 * Returns 0 in case of success, non-zero value in case of failure
2072 */
2074 {
2091 else
2105 }
2108 }
2111 }
2113 /**
2114 * ufshcd_enable_intr - enable interrupts
2115 * @hba: per adapter instance
2116 * @intrs: interrupt bits
2117 */
2119 {
2123 u32 rw;
2128 }
2131 }
2133 /**
2134 * ufshcd_disable_intr - disable interrupts
2135 * @hba: per adapter instance
2136 * @intrs: interrupt bits
2137 */
2139 {
2143 u32 rw;
2150 }
2153 }
2155 /**
2156 * ufshcd_prepare_req_desc_hdr() - Fills the requests header
2157 * descriptor according to request
2158 * @lrbp: pointer to local reference block
2159 * @upiu_flags: flags required in the header
2160 * @cmd_dir: requests data direction
2161 */
2164 {
2166 u32 data_direction;
2167 u32 dword_0;
2178 }
2185 /* Transfer request descriptor header fields */
2187 /* dword_1 is reserved, hence it is set to 0 */
2189 /*
2190 * assigning invalid value for command status. Controller
2191 * updates OCS on command completion, with the command
2192 * status
2193 */
2196 /* dword_3 is reserved, hence it is set to 0 */
2200 }
2202 /**
2203 * ufshcd_prepare_utp_scsi_cmd_upiu() - fills the utp_transfer_req_desc,
2204 * for scsi commands
2205 * @lrbp: local reference block pointer
2206 * @upiu_flags: flags
2207 */
2208 static
2210 {
2214 /* command descriptor fields */
2221 /* Total EHS length and Data segment length will be zero */
2232 }
2234 /**
2235 * ufshcd_prepare_utp_query_req_upiu() - fills the utp_transfer_req_desc,
2236 * for query requsts
2237 * @hba: UFS hba
2238 * @lrbp: local reference block pointer
2239 * @upiu_flags: flags
2240 */
2243 {
2249 /* Query request header */
2256 /* Data segment length only need for WRITE_DESC */
2260 else
2263 /* Copy the Query Request buffer as is */
2265 QUERY_OSF_SIZE);
2267 /* Copy the Descriptor */
2272 }
2275 {
2280 /* command descriptor fields */
2284 /* clear rest of the fields of basic header */
2289 }
2291 /**
2292 * ufshcd_comp_devman_upiu - UFS Protocol Information Unit(UPIU)
2293 * for Device Management Purposes
2294 * @hba: per adapter instance
2295 * @lrbp: pointer to local reference block
2296 */
2298 {
2299 u32 upiu_flags;
2305 else
2313 else
2317 }
2319 /**
2320 * ufshcd_comp_scsi_upiu - UFS Protocol Information Unit(UPIU)
2321 * for SCSI Purposes
2322 * @hba: per adapter instance
2323 * @lrbp: pointer to local reference block
2324 */
2326 {
2327 u32 upiu_flags;
2333 else
2342 }
2345 }
2347 /**
2348 * ufshcd_upiu_wlun_to_scsi_wlun - maps UPIU W-LUN id to SCSI W-LUN ID
2349 * @upiu_wlun_id: UPIU W-LUN id
2350 *
2351 * Returns SCSI W-LUN id
2352 */
2354 {
2356 }
2358 /**
2359 * ufshcd_queuecommand - main entry point for SCSI requests
2360 * @host: SCSI host pointer
2361 * @cmd: command from SCSI Midlayer
2362 *
2363 * Returns 0 for success, non-zero in case of failure
2364 */
2366 {
2381 }
2404 }
2406 /* if error handling is in progress, don't issue commands */
2411 }
2416 /* acquire the tag to make sure device cmds don't use it */
2418 /*
2419 * Dev manage command in progress, requeue the command.
2420 * Requeuing the command helps in cases where the request *may*
2421 * find different tag instead of waiting for dev manage command
2422 * completion.
2423 */
2426 }
2433 }
2454 }
2455 /* Make sure descriptors are ready before ringing the doorbell */
2458 /* issue command to the controller */
2462 out_unlock:
2464 out:
2467 }
2471 {
2481 }
2483 static int
2485 {
2490 /* clear outstanding transaction before retry */
2495 /*
2496 * wait for for h/w to clear corresponding bit in door-bell.
2497 * max. wait is 1 sec.
2498 */
2500 REG_UTP_TRANSFER_REQ_DOOR_BELL,
2504 }
2506 static int
2508 {
2511 /* Get the UPIU response */
2513 UPIU_RSP_CODE_OFFSET;
2515 }
2517 /**
2518 * ufshcd_dev_cmd_completion() - handles device management command responses
2519 * @hba: per adapter instance
2520 * @lrbp: pointer to local reference block
2521 */
2522 static int
2524 {
2537 }
2545 /* TODO: handle Reject UPIU Response */
2548 __func__);
2555 }
2558 }
2562 {
2570 /* Make sure descriptors are ready before ringing the doorbell */
2578 }
2586 /* successfully cleared the command, retry if needed */
2588 /*
2589 * in case of an error, after clearing the doorbell,
2590 * we also need to clear the outstanding_request
2591 * field in hba
2592 */
2594 }
2597 }
2599 /**
2600 * ufshcd_get_dev_cmd_tag - Get device management command tag
2601 * @hba: per-adapter instance
2602 * @tag_out: pointer to variable with available slot value
2603 *
2604 * Get a free slot and lock it until device management command
2605 * completes.
2606 *
2607 * Returns false if free slot is unavailable for locking, else
2608 * return true with tag value in @tag.
2609 */
2611 {
2628 out:
2630 }
2633 {
2635 }
2637 /**
2638 * ufshcd_exec_dev_cmd - API for sending device management requests
2639 * @hba: UFS hba
2640 * @cmd_type: specifies the type (NOP, Query...)
2641 * @timeout: time in seconds
2642 *
2643 * NOTE: Since there is only one available tag for device management commands,
2644 * it is expected you hold the hba->dev_cmd.lock mutex.
2645 */
2648 {
2657 /*
2658 * Get free slot, sleep if slots are unavailable.
2659 * Even though we use wait_event() which sleeps indefinitely,
2660 * the maximum wait time is bounded by SCSI request timeout.
2661 */
2674 /* Make sure descriptors are ready before ringing the doorbell */
2686 out_put_tag:
2691 }
2693 /**
2694 * ufshcd_init_query() - init the query response and request parameters
2695 * @hba: per-adapter instance
2696 * @request: address of the request pointer to be initialized
2697 * @response: address of the response pointer to be initialized
2698 * @opcode: operation to perform
2699 * @idn: flag idn to access
2700 * @index: LU number to access
2701 * @selector: query/flag/descriptor further identification
2702 */
2706 {
2715 }
2719 {
2729 else
2731 }
2738 }
2740 /**
2741 * ufshcd_query_flag() - API function for sending flag query requests
2742 * @hba: per-adapter instance
2743 * @opcode: flag query to perform
2744 * @idn: flag idn to access
2745 * @flag_res: the flag value after the query request completes
2746 *
2747 * Returns 0 for success, non-zero in case of failure
2748 */
2751 {
2762 selector);
2773 /* No dummy reads */
2775 __func__);
2778 }
2786 }
2795 }
2801 out_unlock:
2805 }
2807 /**
2808 * ufshcd_query_attr - API function for sending attribute requests
2809 * @hba: per-adapter instance
2810 * @opcode: attribute opcode
2811 * @idn: attribute idn to access
2812 * @index: index field
2813 * @selector: selector field
2814 * @attr_val: the attribute value after the query request completes
2815 *
2816 * Returns 0 for success, non-zero in case of failure
2817 */
2820 {
2833 }
2837 selector);
2852 }
2860 }
2864 out_unlock:
2866 out:
2869 }
2871 /**
2872 * ufshcd_query_attr_retry() - API function for sending query
2873 * attribute with retries
2874 * @hba: per-adapter instance
2875 * @opcode: attribute opcode
2876 * @idn: attribute idn to access
2877 * @index: index field
2878 * @selector: selector field
2879 * @attr_val: the attribute value after the query request
2880 * completes
2881 *
2882 * Returns 0 for success, non-zero in case of failure
2883 */
2887 {
2889 u32 retries;
2897 else
2899 }
2906 }
2911 {
2924 }
2931 }
2935 selector);
2952 }
2960 }
2965 out_unlock:
2967 out:
2970 }
2972 /**
2973 * ufshcd_query_descriptor_retry - API function for sending descriptor requests
2974 * @hba: per-adapter instance
2975 * @opcode: attribute opcode
2976 * @idn: attribute idn to access
2977 * @index: index field
2978 * @selector: selector field
2979 * @desc_buf: the buffer that contains the descriptor
2980 * @buf_len: length parameter passed to the device
2981 *
2982 * Returns 0 for success, non-zero in case of failure.
2983 * The buf_len parameter will contain, on return, the length parameter
2984 * received on the response.
2985 */
2989 u8 selector,
2991 {
3000 }
3003 }
3005 /**
3006 * ufshcd_read_desc_length - read the specified descriptor length from header
3007 * @hba: Pointer to adapter instance
3008 * @desc_id: descriptor idn value
3009 * @desc_index: descriptor index
3010 * @desc_length: pointer to variable to read the length of descriptor
3011 *
3012 * Return 0 in case of success, non-zero otherwise
3013 */
3018 {
3037 desc_id);
3039 }
3044 }
3046 /**
3047 * ufshcd_map_desc_id_to_length - map descriptor IDN to its length
3048 * @hba: Pointer to adapter instance
3049 * @desc_id: descriptor idn value
3050 * @desc_len: mapped desc length (out)
3051 *
3052 * Return 0 in case of success, non-zero otherwise
3053 */
3056 {
3089 }
3091 }
3094 /**
3095 * ufshcd_read_desc_param - read the specified descriptor parameter
3096 * @hba: Pointer to adapter instance
3097 * @desc_id: descriptor idn value
3098 * @desc_index: descriptor index
3099 * @param_offset: offset of the parameter to read
3100 * @param_read_buf: pointer to buffer where parameter would be read
3101 * @param_size: sizeof(param_read_buf)
3102 *
3103 * Return 0 in case of success, non-zero otherwise
3104 */
3108 u8 param_offset,
3110 u8 param_size)
3111 {
3117 /* Safety check */
3121 /* Get the max length of descriptor from structure filled up at probe
3122 * time.
3123 */
3126 /* Sanity checks */
3129 __func__);
3131 }
3133 /* Check whether we need temp memory */
3141 }
3143 /* Request for full descriptor */
3149 dev_err(hba->dev, "%s: Failed reading descriptor. desc_id %d, desc_index %d, param_offset %d, ret %d",
3152 }
3154 /* Sanity check */
3160 }
3162 /* Check wherher we will not copy more data, than available */
3168 out:
3172 }
3178 u32 size)
3179 {
3181 }
3185 u32 size)
3186 {
3188 }
3191 {
3193 }
3195 /**
3196 * ufshcd_read_string_desc - read string descriptor
3197 * @hba: pointer to adapter instance
3198 * @desc_index: descriptor index
3199 * @buf: pointer to buffer where descriptor would be read
3200 * @size: size of buf
3201 * @ascii: if true convert from unicode to ascii characters
3202 *
3203 * Return 0 in case of success, non-zero otherwise
3204 */
3207 {
3217 }
3226 /* remove header and divide by 2 to move from UTF16 to UTF8 */
3230 __func__);
3233 }
3239 }
3241 /*
3242 * the descriptor contains string in UTF16 format
3243 * we need to convert to utf-8 so it can be displayed
3244 */
3249 /* replace non-printable or non-ASCII characters with spaces */
3258 }
3259 out:
3261 }
3263 /**
3264 * ufshcd_read_unit_desc_param - read the specified unit descriptor parameter
3265 * @hba: Pointer to adapter instance
3266 * @lun: lun id
3267 * @param_offset: offset of the parameter to read
3268 * @param_read_buf: pointer to buffer where parameter would be read
3269 * @param_size: sizeof(param_read_buf)
3270 *
3271 * Return 0 in case of success, non-zero otherwise
3272 */
3277 u32 param_size)
3278 {
3279 /*
3280 * Unit descriptors are only available for general purpose LUs (LUN id
3281 * from 0 to 7) and RPMB Well known LU.
3282 */
3288 }
3290 /**
3291 * ufshcd_memory_alloc - allocate memory for host memory space data structures
3292 * @hba: per adapter instance
3293 *
3294 * 1. Allocate DMA memory for Command Descriptor array
3295 * Each command descriptor consist of Command UPIU, Response UPIU and PRDT
3296 * 2. Allocate DMA memory for UTP Transfer Request Descriptor List (UTRDL).
3297 * 3. Allocate DMA memory for UTP Task Management Request Descriptor List
3298 * (UTMRDL)
3299 * 4. Allocate memory for local reference block(lrb).
3300 *
3301 * Returns 0 for success, non-zero in case of failure
3302 */
3304 {
3307 /* Allocate memory for UTP command descriptors */
3310 ucdl_size,
3312 GFP_KERNEL);
3314 /*
3315 * UFSHCI requires UTP command descriptor to be 128 byte aligned.
3316 * make sure hba->ucdl_dma_addr is aligned to PAGE_SIZE
3317 * if hba->ucdl_dma_addr is aligned to PAGE_SIZE, then it will
3318 * be aligned to 128 bytes as well
3319 */
3325 }
3327 /*
3328 * Allocate memory for UTP Transfer descriptors
3329 * UFSHCI requires 1024 byte alignment of UTRD
3330 */
3333 utrdl_size,
3335 GFP_KERNEL);
3341 }
3343 /*
3344 * Allocate memory for UTP Task Management descriptors
3345 * UFSHCI requires 1024 byte alignment of UTMRD
3346 */
3349 utmrdl_size,
3351 GFP_KERNEL);
3357 }
3359 /* Allocate memory for local reference block */
3362 GFP_KERNEL);
3366 }
3368 out:
3370 }
3372 /**
3373 * ufshcd_host_memory_configure - configure local reference block with
3374 * memory offsets
3375 * @hba: per adapter instance
3376 *
3377 * Configure Host memory space
3378 * 1. Update Corresponding UTRD.UCDBA and UTRD.UCDBAU with UCD DMA
3379 * address.
3380 * 2. Update each UTRD with Response UPIU offset, Response UPIU length
3381 * and PRDT offset.
3382 * 3. Save the corresponding addresses of UTRD, UCD.CMD, UCD.RSP and UCD.PRDT
3383 * into local reference block.
3384 */
3386 {
3389 dma_addr_t cmd_desc_dma_addr;
3390 dma_addr_t cmd_desc_element_addr;
3391 u16 response_offset;
3392 u16 prdt_offset;
3399 response_offset =
3401 prdt_offset =
3408 /* Configure UTRD with command descriptor base address */
3409 cmd_desc_element_addr =
3416 /* Response upiu and prdt offset should be in double words */
3431 }
3442 response_offset;
3446 prdt_offset;
3447 }
3448 }
3450 /**
3451 * ufshcd_dme_link_startup - Notify Unipro to perform link startup
3452 * @hba: per adapter instance
3453 *
3454 * UIC_CMD_DME_LINK_STARTUP command must be issued to Unipro layer,
3455 * in order to initialize the Unipro link startup procedure.
3456 * Once the Unipro links are up, the device connected to the controller
3457 * is detected.
3458 *
3459 * Returns 0 on success, non-zero value on failure
3460 */
3462 {
3473 }
3474 /**
3475 * ufshcd_dme_reset - UIC command for DME_RESET
3476 * @hba: per adapter instance
3477 *
3478 * DME_RESET command is issued in order to reset UniPro stack.
3479 * This function now deal with cold reset.
3480 *
3481 * Returns 0 on success, non-zero value on failure
3482 */
3484 {
3496 }
3498 /**
3499 * ufshcd_dme_enable - UIC command for DME_ENABLE
3500 * @hba: per adapter instance
3501 *
3502 * DME_ENABLE command is issued in order to enable UniPro stack.
3503 *
3504 * Returns 0 on success, non-zero value on failure
3505 */
3507 {
3519 }
3522 {
3523 #define MIN_DELAY_BEFORE_DME_CMDS_US 1000
3529 /*
3530 * last_dme_cmd_tstamp will be 0 only for 1st call to
3531 * this function
3532 */
3542 min_sleep_time_us =
3544 else
3546 }
3548 /* allow sleep for extra 50us if needed */
3550 }
3552 /**
3553 * ufshcd_dme_set_attr - UIC command for DME_SET, DME_PEER_SET
3554 * @hba: per adapter instance
3555 * @attr_sel: uic command argument1
3556 * @attr_set: attribute set type as uic command argument2
3557 * @mib_val: setting value as uic command argument3
3558 * @peer: indicate whether peer or local
3559 *
3560 * Returns 0 on success, non-zero value on failure
3561 */
3564 {
3568 "dme-peer-set"
3569 };
3581 /* for peer attributes we retry upon failure */
3594 }
3597 /**
3598 * ufshcd_dme_get_attr - UIC command for DME_GET, DME_PEER_GET
3599 * @hba: per adapter instance
3600 * @attr_sel: uic command argument1
3601 * @mib_val: the value of the attribute as returned by the UIC command
3602 * @peer: indicate whether peer or local
3603 *
3604 * Returns 0 on success, non-zero value on failure
3605 */
3608 {
3612 "dme-peer-get"
3613 };
3635 }
3640 }
3641 }
3648 /* for peer attributes we retry upon failure */
3666 out:
3668 }
3671 /**
3672 * ufshcd_uic_pwr_ctrl - executes UIC commands (which affects the link power
3673 * state) and waits for it to take effect.
3674 *
3675 * @hba: per adapter instance
3676 * @cmd: UIC command to execute
3677 *
3678 * DME operations like DME_SET(PA_PWRMODE), DME_HIBERNATE_ENTER &
3679 * DME_HIBERNATE_EXIT commands take some time to take its effect on both host
3680 * and device UniPro link and hence it's final completion would be indicated by
3681 * dedicated status bits in Interrupt Status register (UPMS, UHES, UHXS) in
3682 * addition to normal UIC command completion Status (UCCS). This function only
3683 * returns after the relevant status bits indicate the completion.
3684 *
3685 * Returns 0 on success, non-zero value on failure
3686 */
3688 {
3691 u8 status;
3703 /*
3704 * Make sure UIC command completion interrupt is disabled before
3705 * issuing UIC command.
3706 */
3709 }
3717 }
3726 }
3734 }
3735 out:
3740 }
3751 }
3753 /**
3754 * ufshcd_uic_change_pwr_mode - Perform the UIC power mode chage
3755 * using DME_SET primitives.
3756 * @hba: per adapter instance
3757 * @mode: powr mode value
3758 *
3759 * Returns 0 on success, non-zero value on failure
3760 */
3762 {
3773 }
3774 }
3783 out:
3785 }
3788 {
3810 }
3813 {
3829 /*
3830 * If link recovery fails then return error so that caller
3831 * don't retry the hibern8 enter again.
3832 */
3837 POST_CHANGE);
3840 }
3843 {
3850 }
3851 out:
3853 }
3856 {
3874 POST_CHANGE);
3877 }
3880 }
3883 {
3892 }
3894 /**
3895 * ufshcd_init_pwr_info - setting the POR (power on reset)
3896 * values in hba power info
3897 * @hba: per-adapter instance
3898 */
3900 {
3908 }
3910 /**
3911 * ufshcd_get_max_pwr_mode - reads the max power mode negotiated with device
3912 * @hba: per-adapter instance
3913 */
3915 {
3925 /* Get the connected lane count */
3933 __func__,
3937 }
3939 /*
3940 * First, get the maximum gears of HS speed.
3941 * If a zero value, it means there is no HSGEAR capability.
3942 * Then, get the maximum gears of PWM speed.
3943 */
3952 }
3954 }
3965 }
3967 }
3971 }
3975 {
3978 /* if already configured to the requested pwr_mode */
3988 }
3990 /*
3991 * Configure attributes for power mode change with below.
3992 * - PA_RXGEAR, PA_ACTIVERXDATALANES, PA_RXTERMINATION,
3993 * - PA_TXGEAR, PA_ACTIVETXDATALANES, PA_TXTERMINATION,
3994 * - PA_HSSERIES
3995 */
4002 else
4011 else
4029 pwr_mode);
4033 }
4036 }
4038 /**
4039 * ufshcd_config_pwr_mode - configure a new power mode
4040 * @hba: per-adapter instance
4041 * @desired_pwr_mode: desired power configuration
4042 */
4045 {
4060 }
4063 /**
4064 * ufshcd_complete_dev_init() - checks device readiness
4065 * @hba: per-adapter instance
4066 *
4067 * Set fDeviceInit flag and poll until device toggles it.
4068 */
4070 {
4082 }
4084 /* poll for max. 1000 iterations for fDeviceInit flag to clear */
4096 __func__);
4098 out:
4100 }
4102 /**
4103 * ufshcd_make_hba_operational - Make UFS controller operational
4104 * @hba: per adapter instance
4105 *
4106 * To bring UFS host controller to operational state,
4107 * 1. Enable required interrupts
4108 * 2. Configure interrupt aggregation
4109 * 3. Program UTRL and UTMRL base address
4110 * 4. Configure run-stop-registers
4111 *
4112 * Returns 0 on success, non-zero value on failure
4113 */
4115 {
4117 u32 reg;
4119 /* Enable required interrupts */
4122 /* Configure interrupt aggregation */
4125 else
4128 /* Configure UTRL and UTMRL base address registers */
4130 REG_UTP_TRANSFER_REQ_LIST_BASE_L);
4132 REG_UTP_TRANSFER_REQ_LIST_BASE_H);
4134 REG_UTP_TASK_REQ_LIST_BASE_L);
4136 REG_UTP_TASK_REQ_LIST_BASE_H);
4138 /*
4139 * Make sure base address and interrupt setup are updated before
4140 * enabling the run/stop registers below.
4141 */
4144 /*
4145 * UCRDY, UTMRLDY and UTRLRDY bits must be 1
4146 */
4155 }
4157 out:
4159 }
4161 /**
4162 * ufshcd_hba_stop - Send controller to reset state
4163 * @hba: per adapter instance
4164 * @can_sleep: perform sleep or just spin
4165 */
4167 {
4176 }
4178 /**
4179 * ufshcd_hba_execute_hce - initialize the controller
4180 * @hba: per adapter instance
4181 *
4182 * The controller resets itself and controller firmware initialization
4183 * sequence kicks off. When controller is ready it will set
4184 * the Host Controller Enable bit to 1.
4185 *
4186 * Returns 0 on success, non-zero value on failure
4187 */
4189 {
4192 /*
4193 * msleep of 1 and 5 used in this function might result in msleep(20),
4194 * but it was necessary to send the UFS FPGA to reset mode during
4195 * development and testing of this driver. msleep can be changed to
4196 * mdelay and retry count can be reduced based on the controller.
4197 */
4199 /* change controller state to "reset state" */
4202 /* UniPro link is disabled at this point */
4207 /* start controller initialization sequence */
4210 /*
4211 * To initialize a UFS host controller HCE bit must be set to 1.
4212 * During initialization the HCE bit value changes from 1->0->1.
4213 * When the host controller completes initialization sequence
4214 * it sets the value of HCE bit to 1. The same HCE bit is read back
4215 * to check if the controller has completed initialization sequence.
4216 * So without this delay the value HCE = 1, set in the previous
4217 * instruction might be read back.
4218 * This delay can be changed based on the controller.
4219 */
4222 /* wait for the host controller to complete initialization */
4226 retry--;
4231 }
4233 }
4235 /* enable UIC related interrupts */
4241 }
4244 {
4251 /* enable UIC related interrupts */
4261 }
4264 }
4267 }
4269 {
4275 else
4284 else
4293 }
4294 }
4297 }
4300 {
4302 }
4304 /**
4305 * ufshcd_link_startup - Initialize unipro link startup
4306 * @hba: per adapter instance
4307 *
4308 * Returns 0 for success, non-zero in case of failure
4309 */
4311 {
4316 /*
4317 * If UFS device isn't active then we will have to issue link startup
4318 * 2 times to make sure the device state move to active.
4319 */
4323 link_startup:
4329 /* check if device is detected by inter-connect layer */
4334 }
4336 /*
4337 * DME link lost indication is only received when link is up,
4338 * but we can't be sure if the link is up until link startup
4339 * succeeds. So reset the local Uni-Pro and try again.
4340 */
4346 /* failed to get the link up... retire */
4353 }
4355 /* Mark that link is up in PWM-G1, 1-lane, SLOW-AUTO mode */
4363 }
4365 /* Include any host controller configuration via UIC commands */
4371 out:
4377 }
4379 }
4381 /**
4382 * ufshcd_verify_dev_init() - Verify device initialization
4383 * @hba: per-adapter instance
4384 *
4385 * Send NOP OUT UPIU and wait for NOP IN response to check whether the
4386 * device Transport Protocol (UTP) layer is ready after a reset.
4387 * If the UTP layer at the device side is not initialized, it may
4388 * not respond with NOP IN UPIU within timeout of %NOP_OUT_TIMEOUT
4389 * and we retry sending NOP OUT for %NOP_OUT_RETRIES iterations.
4390 */
4392 {
4400 NOP_OUT_TIMEOUT);
4406 }
4413 }
4415 /**
4416 * ufshcd_set_queue_depth - set lun queue depth
4417 * @sdev: pointer to SCSI device
4418 *
4419 * Read bLUQueueDepth value and activate scsi tagged command
4420 * queueing. For WLUN, queue depth is set to 1. For best-effort
4421 * cases (bLUQueueDepth = 0) the queue depth is set to a maximum
4422 * value that host can queue.
4423 */
4425 {
4427 u8 lun_qdepth;
4435 UNIT_DESC_PARAM_LU_Q_DEPTH,
4439 /* Some WLUN doesn't support unit descriptor */
4443 /* eventually, we can figure out the real queue depth */
4445 else
4451 }
4453 /*
4454 * ufshcd_get_lu_wp - returns the "b_lu_write_protect" from UNIT DESCRIPTOR
4455 * @hba: per-adapter instance
4456 * @lun: UFS device lun id
4457 * @b_lu_write_protect: pointer to buffer to hold the LU's write protect info
4458 *
4459 * Returns 0 in case of success and b_lu_write_protect status would be returned
4460 * @b_lu_write_protect parameter.
4461 * Returns -ENOTSUPP if reading b_lu_write_protect is not supported.
4462 * Returns -EINVAL in case of invalid parameters passed to this function.
4463 */
4465 u8 lun,
4467 {
4472 /*
4473 * According to UFS device spec, RPMB LU can't be write
4474 * protected so skip reading bLUWriteProtect parameter for
4475 * it. For other W-LUs, UNIT DESCRIPTOR is not available.
4476 */
4479 else
4481 lun,
4482 UNIT_DESC_PARAM_LU_WR_PROTECT,
4483 b_lu_write_protect,
4486 }
4488 /**
4489 * ufshcd_get_lu_power_on_wp_status - get LU's power on write protect
4490 * status
4491 * @hba: per-adapter instance
4492 * @sdev: pointer to SCSI device
4493 *
4494 */
4497 {
4500 u8 b_lu_write_protect;
4506 }
4507 }
4509 /**
4510 * ufshcd_slave_alloc - handle initial SCSI device configurations
4511 * @sdev: pointer to SCSI device
4512 *
4513 * Returns success
4514 */
4516 {
4521 /* Mode sense(6) is not supported by UFS, so use Mode sense(10) */
4524 /* allow SCSI layer to restart the device in case of errors */
4527 /* REPORT SUPPORTED OPERATION CODES is not supported */
4530 /* WRITE_SAME command is not supported */
4538 }
4540 /**
4541 * ufshcd_change_queue_depth - change queue depth
4542 * @sdev: pointer to SCSI device
4543 * @depth: required depth to set
4544 *
4545 * Change queue depth and make sure the max. limits are not crossed.
4546 */
4548 {
4554 }
4556 /**
4557 * ufshcd_slave_configure - adjust SCSI device configurations
4558 * @sdev: pointer to SCSI device
4559 */
4561 {
4568 }
4570 /**
4571 * ufshcd_slave_destroy - remove SCSI device configurations
4572 * @sdev: pointer to SCSI device
4573 */
4575 {
4579 /* Drop the reference as it won't be needed anymore */
4586 }
4587 }
4589 /**
4590 * ufshcd_task_req_compl - handle task management request completion
4591 * @hba: per adapter instance
4592 * @index: index of the completed request
4593 * @resp: task management service response
4594 *
4595 * Returns non-zero value on error, zero on success
4596 */
4598 {
4607 /* Clear completed tasks from outstanding_tasks */
4623 }
4627 }
4629 /**
4630 * ufshcd_scsi_cmd_status - Update SCSI command result based on SCSI status
4631 * @lrbp: pointer to local reference block of completed command
4632 * @scsi_status: SCSI command status
4633 *
4634 * Returns value base on SCSI command status
4635 */
4638 {
4647 scsi_status;
4661 }
4663 /**
4664 * ufshcd_transfer_rsp_status - Get overall status of the response
4665 * @hba: per adapter instance
4666 * @lrbp: pointer to local reference block of completed command
4667 *
4668 * Returns result of the command to notify SCSI midlayer
4669 */
4672 {
4677 /* overall command status of utrd */
4686 /*
4687 * get the response UPIU result to extract
4688 * the SCSI command status
4689 */
4692 /*
4693 * get the result based on SCSI status response
4694 * to notify the SCSI midlayer of the command status
4695 */
4699 /*
4700 * Currently we are only supporting BKOPs exception
4701 * events hence we can ignore BKOPs exception event
4702 * during power management callbacks. BKOPs exception
4703 * event is not expected to be raised in runtime suspend
4704 * callback as it allows the urgent bkops.
4705 * During system suspend, we are anyway forcefully
4706 * disabling the bkops and if urgent bkops is needed
4707 * it will be enabled on system resume. Long term
4708 * solution could be to abort the system suspend if
4709 * UFS device needs urgent BKOPs.
4710 */
4716 /* TODO: handle Reject UPIU Response */
4725 result);
4727 }
4754 }
4756 /**
4757 * ufshcd_uic_cmd_compl - handle completion of uic command
4758 * @hba: per adapter instance
4759 * @intr_status: interrupt status generated by the controller
4760 */
4762 {
4769 }
4773 }
4775 /**
4776 * __ufshcd_transfer_req_compl - handle SCSI and query command completion
4777 * @hba: per adapter instance
4778 * @completed_reqs: requests to complete
4779 */
4782 {
4796 /* Mark completed command as NULL in LRB */
4799 /* Do not touch lrbp after scsi done */
4808 }
4809 }
4814 }
4816 /* clear corresponding bits of completed commands */
4821 /* we might have free'd some tags above */
4823 }
4825 /**
4826 * ufshcd_transfer_req_compl - handle SCSI and query command completion
4827 * @hba: per adapter instance
4828 */
4830 {
4832 u32 tr_doorbell;
4834 /* Resetting interrupt aggregation counters first and reading the
4835 * DOOR_BELL afterward allows us to handle all the completed requests.
4836 * In order to prevent other interrupts starvation the DB is read once
4837 * after reset. The down side of this solution is the possibility of
4838 * false interrupt if device completes another request after resetting
4839 * aggregation and before reading the DB.
4840 */
4849 }
4851 /**
4852 * ufshcd_disable_ee - disable exception event
4853 * @hba: per-adapter instance
4854 * @mask: exception event to disable
4855 *
4856 * Disables exception event in the device so that the EVENT_ALERT
4857 * bit is not set.
4858 *
4859 * Returns zero on success, non-zero error value on failure.
4860 */
4862 {
4864 u32 val;
4875 out:
4877 }
4879 /**
4880 * ufshcd_enable_ee - enable exception event
4881 * @hba: per-adapter instance
4882 * @mask: exception event to enable
4883 *
4884 * Enable corresponding exception event in the device to allow
4885 * device to alert host in critical scenarios.
4886 *
4887 * Returns zero on success, non-zero error value on failure.
4888 */
4890 {
4892 u32 val;
4903 out:
4905 }
4907 /**
4908 * ufshcd_enable_auto_bkops - Allow device managed BKOPS
4909 * @hba: per-adapter instance
4910 *
4911 * Allow device to manage background operations on its own. Enabling
4912 * this might lead to inconsistent latencies during normal data transfers
4913 * as the device is allowed to manage its own way of handling background
4914 * operations.
4915 *
4916 * Returns zero on success, non-zero on failure.
4917 */
4919 {
4931 }
4936 /* No need of URGENT_BKOPS exception from the device */
4941 out:
4943 }
4945 /**
4946 * ufshcd_disable_auto_bkops - block device in doing background operations
4947 * @hba: per-adapter instance
4948 *
4949 * Disabling background operations improves command response latency but
4950 * has drawback of device moving into critical state where the device is
4951 * not-operable. Make sure to call ufshcd_enable_auto_bkops() whenever the
4952 * host is idle so that BKOPS are managed effectively without any negative
4953 * impacts.
4954 *
4955 * Returns zero on success, non-zero on failure.
4956 */
4958 {
4964 /*
4965 * If host assisted BKOPs is to be enabled, make sure
4966 * urgent bkops exception is allowed.
4967 */
4973 }
4982 }
4986 out:
4988 }
4990 /**
4991 * ufshcd_force_reset_auto_bkops - force reset auto bkops state
4992 * @hba: per adapter instance
4993 *
4994 * After a device reset the device may toggle the BKOPS_EN flag
4995 * to default value. The s/w tracking variables should be updated
4996 * as well. This function would change the auto-bkops state based on
4997 * UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND.
4998 */
5000 {
5009 }
5010 }
5013 {
5016 }
5018 /**
5019 * ufshcd_bkops_ctrl - control the auto bkops based on current bkops status
5020 * @hba: per-adapter instance
5021 * @status: bkops_status value
5022 *
5023 * Read the bkops_status from the UFS device and Enable fBackgroundOpsEn
5024 * flag in the device to permit background operations if the device
5025 * bkops_status is greater than or equal to "status" argument passed to
5026 * this function, disable otherwise.
5027 *
5028 * Returns 0 for success, non-zero in case of failure.
5029 *
5030 * NOTE: Caller of this function can check the "hba->auto_bkops_enabled" flag
5031 * to know whether auto bkops is enabled or disabled after this function
5032 * returns control to it.
5033 */
5036 {
5050 }
5054 else
5056 out:
5058 }
5060 /**
5061 * ufshcd_urgent_bkops - handle urgent bkops exception event
5062 * @hba: per-adapter instance
5063 *
5064 * Enable fBackgroundOpsEn flag in the device to permit background
5065 * operations.
5066 *
5067 * If BKOPs is enabled, this function returns 0, 1 if the bkops in not enabled
5068 * and negative error value for any other failure.
5069 */
5071 {
5073 }
5076 {
5079 }
5082 {
5094 }
5096 /*
5097 * We are seeing that some devices are raising the urgent bkops
5098 * exception events even when BKOPS status doesn't indicate performace
5099 * impacted or critical. Handle these device by determining their urgent
5100 * bkops status at runtime.
5101 */
5105 /* update the current status as the urgent bkops level */
5108 }
5110 enable_auto_bkops:
5112 out:
5116 }
5118 /**
5119 * ufshcd_exception_event_handler - handle exceptions raised by device
5120 * @work: pointer to work data
5121 *
5122 * Read bExceptionEventStatus attribute from the device and handle the
5123 * exception event accordingly.
5124 */
5126 {
5139 }
5146 out:
5150 }
5152 /* Complete requests that have door-bell cleared */
5154 {
5157 }
5159 /**
5160 * ufshcd_quirk_dl_nac_errors - This function checks if error handling is
5161 * to recover from the DL NAC errors or not.
5162 * @hba: per-adapter instance
5163 *
5164 * Returns true if error handling is required, false otherwise
5165 */
5167 {
5172 /*
5173 * UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS only workaround the
5174 * device fatal error and/or DL NAC & REPLAY timeout errors.
5175 */
5187 /*
5188 * wait for 50ms to see if we can get any other errors or not.
5189 */
5194 /*
5195 * now check if we have got any other severe errors other than
5196 * DL NAC error?
5197 */
5203 /*
5204 * As DL NAC is the only error received so far, send out NOP
5205 * command to confirm if link is still active or not.
5206 * - If we don't get any response then do error recovery.
5207 * - If we get response then clear the DL NAC error bit.
5208 */
5217 /* Link seems to be alive hence ignore the DL NAC errors */
5220 /* clear NAC error */
5225 }
5226 }
5227 out:
5230 }
5232 /**
5233 * ufshcd_err_handler - handle UFS errors that require s/w attention
5234 * @work: pointer to work structure
5235 */
5237 {
5258 /* Complete requests that have door-bell cleared by h/w */
5265 /* release the lock as ufshcd_quirk_dl_nac_errors() may sleep */
5270 }
5274 UFSHCD_UIC_DL_NAC_RECEIVED_ERROR |
5275 UFSHCD_UIC_DL_TCx_REPLAY_ERROR))))
5278 /*
5279 * if host reset is required then skip clearing the pending
5280 * transfers forcefully because they will automatically get
5281 * cleared after link startup.
5282 */
5286 /* release lock as clear command might sleep */
5288 /* Clear pending transfer requests */
5293 }
5294 }
5296 /* Clear pending task management requests */
5301 }
5302 }
5304 lock_skip_pending_xfer_clear:
5307 /* Complete the requests that are cleared by s/w */
5313 skip_pending_xfer_clear:
5314 /* Fatal errors need reset */
5318 /*
5319 * ufshcd_reset_and_restore() does the link reinitialization
5320 * which will need atleast one empty doorbell slot to send the
5321 * device management commands (NOP and query commands).
5322 * If there is no slot empty at this moment then free up last
5323 * slot forcefully.
5324 */
5334 __func__);
5336 }
5337 /*
5338 * Inform scsi mid-layer that we did reset and allow to handle
5339 * Unit Attention properly.
5340 */
5344 }
5346 skip_err_handling:
5352 }
5356 out:
5361 }
5364 u32 reg)
5365 {
5369 }
5371 /**
5372 * ufshcd_update_uic_error - check and set fatal UIC error flags.
5373 * @hba: per-adapter instance
5374 */
5376 {
5377 u32 reg;
5379 /* PHY layer lane error */
5381 /* Ignore LINERESET indication, as this is not an error */
5384 /*
5385 * To know whether this error is fatal or not, DB timeout
5386 * must be checked but this error is handled separately.
5387 */
5390 }
5392 /* PA_INIT_ERROR is fatal and needs UIC reset */
5400 UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS) {
5403 UFSHCD_UIC_DL_NAC_RECEIVED_ERROR;
5406 }
5408 /* UIC NL/TL/DME errors needs software retry */
5413 }
5419 }
5425 }
5429 }
5431 /**
5432 * ufshcd_check_errors - Check for errors that need s/w attention
5433 * @hba: per-adapter instance
5434 */
5436 {
5447 }
5450 /*
5451 * update the transfer error masks to sticky bits, let's do this
5452 * irrespective of current ufshcd_state.
5453 */
5457 /* handle fatal errors only when link is functional */
5459 /* block commands from scsi mid-layer */
5464 /* dump controller state before resetting */
5467 SYSTEM_BUS_FATAL_ERROR);
5477 pr_prdt);
5478 }
5480 }
5481 }
5482 /*
5483 * if (!queue_eh_work) -
5484 * Other errors are either non-fatal where host recovers
5485 * itself without s/w intervention or errors that will be
5486 * handled by the SCSI core layer.
5487 */
5488 }
5490 /**
5491 * ufshcd_tmc_handler - handle task management function completion
5492 * @hba: per adapter instance
5493 */
5495 {
5496 u32 tm_doorbell;
5501 }
5503 /**
5504 * ufshcd_sl_intr - Interrupt service routine
5505 * @hba: per adapter instance
5506 * @intr_status: contains interrupts generated by the controller
5507 */
5509 {
5522 }
5524 /**
5525 * ufshcd_intr - Main interrupt service routine
5526 * @irq: irq number
5527 * @__hba: pointer to adapter instance
5528 *
5529 * Returns IRQ_HANDLED - If interrupt is valid
5530 * IRQ_NONE - If invalid interrupt
5531 */
5533 {
5542 /*
5543 * There could be max of hba->nutrs reqs in flight and in worst case
5544 * if the reqs get finished 1 by 1 after the interrupt status is
5545 * read, make sure we handle them by checking the interrupt status
5546 * again in a loop until we process all of the reqs before returning.
5547 */
5549 enabled_intr_status =
5556 }
5563 }
5566 {
5578 /* poll for max. 1 sec to clear door bell register by h/w */
5580 REG_UTP_TASK_REQ_DOOR_BELL,
5582 out:
5584 }
5586 /**
5587 * ufshcd_issue_tm_cmd - issues task management commands to controller
5588 * @hba: per adapter instance
5589 * @lun_id: LUN ID to which TM command is sent
5590 * @task_id: task ID to which the TM command is applicable
5591 * @tm_function: task management function opcode
5592 * @tm_response: task management service response return value
5593 *
5594 * Returns non-zero value on error, zero on success.
5595 */
5598 {
5609 /*
5610 * Get free slot, sleep if slots are unavailable.
5611 * Even though we use wait_event() which sleeps indefinitely,
5612 * the maximum wait time is bounded by %TM_CMD_TIMEOUT.
5613 */
5621 /* Configure task request descriptor */
5626 /* Configure task request UPIU */
5627 task_req_upiup =
5635 /*
5636 * The host shall provide the same value for LUN field in the basic
5637 * header and for Input Parameter.
5638 */
5644 /* send command to the controller */
5647 /* Make sure descriptors are ready before ringing the task doorbell */
5651 /* Make sure that doorbell is committed immediately */
5658 /* wait until the task management command is completed */
5673 }
5681 }
5683 /**
5684 * ufshcd_eh_device_reset_handler - device reset handler registered to
5685 * scsi layer.
5686 * @cmd: SCSI command pointer
5687 *
5688 * Returns SUCCESS/FAILED
5689 */
5691 {
5695 u32 pos;
5711 }
5713 /* clear the commands that were pending for corresponding LUN */
5719 }
5720 }
5725 out:
5732 }
5734 }
5737 {
5744 }
5745 }
5747 /**
5748 * ufshcd_abort - abort a specific command
5749 * @cmd: SCSI command pointer
5750 *
5751 * Abort the pending command in device by sending UFS_ABORT_TASK task management
5752 * command, and in host controller by clearing the door-bell register. There can
5753 * be race between controller sending the command to the device while abort is
5754 * issued. To avoid that, first issue UFS_QUERY_TASK to check if the command is
5755 * really issued and then try to abort it.
5756 *
5757 * Returns SUCCESS/FAILED
5758 */
5760 {
5769 u32 reg;
5780 }
5782 /*
5783 * Task abort to the device W-LUN is illegal. When this command
5784 * will fail, due to spec violation, scsi err handling next step
5785 * will be to send LU reset which, again, is a spec violation.
5786 * To avoid these unnecessary/illegal step we skip to the last error
5787 * handling stage: reset and restore.
5788 */
5794 /* If command is already aborted/completed, return SUCCESS */
5800 }
5806 }
5808 /* Print Transfer Request of aborted task */
5811 /*
5812 * Print detailed info about aborted request.
5813 * As more than one request might get aborted at the same time,
5814 * print full information only for the first aborted request in order
5815 * to reduce repeated printouts. For other aborted requests only print
5816 * basic details.
5817 */
5826 }
5829 /* Skip task abort in case previous aborts failed and report failure */
5833 }
5839 /* cmd pending in the device */
5844 /*
5845 * cmd not pending in the device, check if it is
5846 * in transition.
5847 */
5852 /* sleep for max. 200us to stabilize */
5855 }
5856 /* command completed already */
5867 }
5868 }
5873 }
5882 }
5884 }
5891 }
5903 out:
5910 }
5912 /*
5913 * This ufshcd_release() corresponds to the original scsi cmd that got
5914 * aborted here (as we won't get any IRQ for it).
5915 */
5918 }
5920 /**
5921 * ufshcd_host_reset_and_restore - reset and restore host controller
5922 * @hba: per-adapter instance
5923 *
5924 * Note that host controller reset may issue DME_RESET to
5925 * local and remote (device) Uni-Pro stack and the attributes
5926 * are reset to default state.
5927 *
5928 * Returns zero on success, non-zero on failure
5929 */
5931 {
5935 /* Reset the host controller */
5940 /* scale up clocks to max frequency before full reinitialization */
5947 /* Establish the link again and restore the device */
5952 out:
5957 }
5959 /**
5960 * ufshcd_reset_and_restore - reset and re-initialize host/device
5961 * @hba: per-adapter instance
5962 *
5963 * Reset and recover device, host and re-establish link. This
5964 * is helpful to recover the communication in fatal error conditions.
5965 *
5966 * Returns zero on success, non-zero on failure
5967 */
5969 {
5978 /*
5979 * After reset the door-bell might be cleared, complete
5980 * outstanding requests in s/w here.
5981 */
5988 }
5990 /**
5991 * ufshcd_eh_host_reset_handler - host reset handler registered to scsi layer
5992 * @cmd: SCSI command pointer
5993 *
5994 * Returns SUCCESS/FAILED
5995 */
5997 {
6005 /*
6006 * Check if there is any race with fatal error handling.
6007 * If so, wait for it to complete. Even though fatal error
6008 * handling does reset and restore in some cases, don't assume
6009 * anything out of it. We are just avoiding race here.
6010 */
6035 }
6041 }
6043 /**
6044 * ufshcd_get_max_icc_level - calculate the ICC level
6045 * @sup_curr_uA: max. current supported by the regulator
6046 * @start_scan: row at the desc table to start scan from
6047 * @buff: power descriptor buffer
6048 *
6049 * Returns calculated max ICC level for specific regulator
6050 */
6052 {
6055 u16 data;
6056 u16 unit;
6061 ATTR_ICC_LVL_UNIT_OFFSET;
6076 }
6079 }
6083 }
6086 }
6088 /**
6089 * ufshcd_calc_icc_level - calculate the max ICC level
6090 * In case regulators are not initialized we'll return 0
6091 * @hba: per-adapter instance
6092 * @desc_buf: power descriptor buffer to extract ICC levels from.
6093 * @len: length of desc_buff
6094 *
6095 * Returns calculated ICC level
6096 */
6099 {
6108 }
6119 icc_level,
6125 icc_level,
6127 out:
6129 }
6132 {
6147 }
6164 out:
6166 }
6168 /**
6169 * ufshcd_scsi_add_wlus - Adds required W-LUs
6170 * @hba: per-adapter instance
6171 *
6172 * UFS device specification requires the UFS devices to support 4 well known
6173 * logical units:
6174 * "REPORT_LUNS" (address: 01h)
6175 * "UFS Device" (address: 50h)
6176 * "RPMB" (address: 44h)
6177 * "BOOT" (address: 30h)
6178 * UFS device's power management needs to be controlled by "POWER CONDITION"
6179 * field of SSU (START STOP UNIT) command. But this "power condition" field
6180 * will take effect only when its sent to "UFS device" well known logical unit
6181 * hence we require the scsi_device instance to represent this logical unit in
6182 * order for the UFS host driver to send the SSU command for power management.
6183 *
6184 * We also require the scsi_device instance for "RPMB" (Replay Protected Memory
6185 * Block) LU so user space process can control this LU. User space may also
6186 * want to have access to BOOT LU.
6187 *
6188 * This function adds scsi device instances for each of all well known LUs
6189 * (except "REPORT LUNS" LU).
6190 *
6191 * Returns zero on success (all required W-LUs are added successfully),
6192 * non-zero error value on failure (if failed to add any of the required W-LU).
6193 */
6195 {
6206 }
6214 }
6221 else
6225 remove_sdev_ufs_device:
6227 out:
6229 }
6233 {
6236 u8 model_index;
6245 }
6252 }
6254 /*
6255 * getting vendor (manufacturerID) and Bank Index in big endian
6256 * format
6257 */
6263 /* Zero-pad entire buffer for string termination. */
6272 }
6277 MAX_MODEL_LEN));
6279 /* Null terminate the model string */
6282 out:
6285 }
6289 {
6298 }
6299 }
6301 /**
6302 * ufshcd_tune_pa_tactivate - Tunes PA_TActivate of local UniPro
6303 * @hba: per-adapter instance
6304 *
6305 * PA_TActivate parameter can be tuned manually if UniPro version is less than
6306 * 1.61. PA_TActivate needs to be greater than or equal to peerM-PHY's
6307 * RX_MIN_ACTIVATETIME_CAPABILITY attribute. This optimal value can help reduce
6308 * the hibern8 exit latency.
6309 *
6310 * Returns zero on success, non-zero error value on failure.
6311 */
6313 {
6319 RX_MIN_ACTIVATETIME_CAPABILITY,
6325 /* make sure proper unit conversion is applied */
6326 tuned_pa_tactivate =
6330 tuned_pa_tactivate);
6332 out:
6334 }
6336 /**
6337 * ufshcd_tune_pa_hibern8time - Tunes PA_Hibern8Time of local UniPro
6338 * @hba: per-adapter instance
6339 *
6340 * PA_Hibern8Time parameter can be tuned manually if UniPro version is less than
6341 * 1.61. PA_Hibern8Time needs to be maximum of local M-PHY's
6342 * TX_HIBERN8TIME_CAPABILITY & peer M-PHY's RX_HIBERN8TIME_CAPABILITY.
6343 * This optimal value can help reduce the hibern8 exit latency.
6344 *
6345 * Returns zero on success, non-zero error value on failure.
6346 */
6348 {
6368 peer_rx_hibern8_time_cap);
6369 /* make sure proper unit conversion is applied */
6373 tuned_pa_hibern8time);
6374 out:
6376 }
6378 /**
6379 * ufshcd_quirk_tune_host_pa_tactivate - Ensures that host PA_TACTIVATE is
6380 * less than device PA_TACTIVATE time.
6381 * @hba: per-adapter instance
6382 *
6383 * Some UFS devices require host PA_TACTIVATE to be lower than device
6384 * PA_TACTIVATE, we need to enable UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE quirk
6385 * for such devices.
6386 *
6387 * Returns zero on success, non-zero error value on failure.
6388 */
6390 {
6412 }
6419 }
6435 u32 new_peer_pa_tactivate;
6439 new_peer_pa_tactivate++;
6441 new_peer_pa_tactivate);
6442 }
6444 out:
6446 }
6449 {
6453 }
6456 /* set 1ms timeout for PA_TACTIVATE */
6463 }
6466 {
6479 }
6482 {
6518 }
6521 {
6529 }
6531 /**
6532 * ufshcd_probe_hba - probe hba to detect device and initialize
6533 * @hba: per-adapter instance
6534 *
6535 * Execute link-startup and verify device initialization
6536 */
6538 {
6547 /* set the default level for urgent bkops */
6551 /* Debug counters initialization */
6554 /* UniPro link is active now */
6557 /* Enable Auto-Hibernate if configured */
6568 /* Init check for device descriptor sizes */
6576 }
6586 /* UFS device is also active now */
6594 __func__);
6601 }
6602 }
6604 /* set the state as operational after switching to desired gear */
6607 /*
6608 * If we are in error handling context or in power management callbacks
6609 * context, no need to scan the host
6610 */
6614 /* clear any previous UFS device information */
6623 /* Add required well known logical units to scsi mid layer */
6627 /* Initialize devfreq after UFS device is detected */
6637 }
6639 }
6643 }
6648 out:
6649 /*
6650 * If we failed to initialize the device or the device is not
6651 * present, turn off the power/clocks etc.
6652 */
6656 }
6662 }
6664 /**
6665 * ufshcd_async_scan - asynchronous execution for probing hba
6666 * @data: data pointer to pass to this function
6667 * @cookie: cookie data
6668 */
6670 {
6674 }
6677 {
6698 }
6699 }
6703 /*
6704 * Bypass SCSI error handling and reset the block layer timer if this
6705 * SCSI command was not actually dispatched to UFS driver, otherwise
6706 * let SCSI layer handle the error as usual.
6707 */
6709 }
6714 NULL,
6715 };
6737 };
6741 {
6751 }
6754 }
6758 {
6763 else
6765 UFS_VREG_LPM_LOAD_UA);
6766 }
6770 {
6775 else
6777 }
6781 {
6799 }
6805 }
6806 out:
6808 }
6811 {
6825 else
6828 out:
6830 }
6833 {
6844 /* ignore errors on applying disable config */
6850 }
6851 out:
6853 }
6856 {
6876 out:
6881 }
6883 }
6886 {
6893 }
6896 {
6907 }
6908 out:
6910 }
6913 {
6930 out:
6932 }
6935 {
6942 }
6945 {
6955 /* shut off the rail here */
6957 /*
6958 * Mark this rail as no longer used, so it doesn't get enabled
6959 * later by mistake
6960 */
6964 /*
6965 * rail should have been already enabled hence just make sure
6966 * that unused flag is cleared.
6967 */
6969 }
6970 out:
6972 }
6976 {
6987 /*
6988 * vendor specific setup_clocks ops may depend on clocks managed by
6989 * this standard driver hence call the vendor specific setup_clocks
6990 * before disabling the clocks managed here.
6991 */
6996 }
7010 }
7013 }
7017 }
7018 }
7020 /*
7021 * vendor specific setup_clocks ops may depend on clocks managed by
7022 * this standard driver hence call the vendor specific setup_clocks
7023 * after enabling the clocks managed here.
7024 */
7029 }
7031 out:
7036 }
7043 }
7050 }
7053 {
7055 }
7058 {
7077 }
7086 }
7088 }
7091 }
7092 out:
7094 }
7097 {
7113 out_exit:
7115 out:
7120 }
7123 {
7130 }
7133 {
7136 /*
7137 * Handle host controller power separately from the UFS device power
7138 * rails as it will help controlling the UFS host controller power
7139 * collapse easily which is different than UFS device power collapse.
7140 * Also, enable the host controller power before we go ahead with rest
7141 * of the initialization here.
7142 */
7174 out_disable_vreg:
7176 out_disable_clks:
7178 out_disable_hba_vreg:
7180 out:
7182 }
7185 {
7195 }
7199 }
7200 }
7202 static int
7204 {
7209 UFSHCD_REQ_SENSE_SIZE,
7218 }
7227 out:
7229 }
7231 /**
7232 * ufshcd_set_dev_pwr_mode - sends START STOP UNIT command to set device
7233 * power mode
7234 * @hba: per adapter instance
7235 * @pwr_mode: device power mode to set
7236 *
7237 * Returns 0 if requested power mode is set successfully
7238 * Returns non-zero if failed to set the requested power mode
7239 */
7242 {
7256 }
7259 }
7265 /*
7266 * If scsi commands fail, the scsi mid-layer schedules scsi error-
7267 * handling, which would wait for host to be resumed. Since we know
7268 * we are functional while we are here, skip host resume in error
7269 * handling context.
7270 */
7276 /* Unit attention condition is cleared now */
7278 }
7282 /*
7283 * Current function would be generally called from the power management
7284 * callbacks hence set the RQF_PM flag so that it doesn't resume the
7285 * already suspended childs.
7286 */
7295 }
7299 out:
7303 }
7308 {
7318 else
7320 }
7321 /*
7322 * If autobkops is enabled, link can't be turned off because
7323 * turning off the link would also turn off the device.
7324 */
7328 /*
7329 * Let's make sure that link is in low power mode, we are doing
7330 * this currently by putting the link in Hibern8. Otherway to
7331 * put the link in low power mode is to send the DME end point
7332 * to device and then send the DME reset command to local
7333 * unipro. But putting the link in hibern8 is much faster.
7334 */
7338 /*
7339 * Change controller state to "reset state" which
7340 * should also put the link in off/reset state
7341 */
7343 /*
7344 * TODO: Check if we need any delay to make sure that
7345 * controller is reset
7346 */
7348 }
7350 out:
7352 }
7355 {
7356 /*
7357 * It seems some UFS devices may keep drawing more than sleep current
7358 * (atleast for 500us) from UFS rails (especially from VCCQ rail).
7359 * To avoid this situation, add 2ms delay before putting these UFS
7360 * rails in LPM mode.
7361 */
7366 /*
7367 * If UFS device is either in UFS_Sleep turn off VCC rail to save some
7368 * power.
7369 *
7370 * If UFS device and link is in OFF state, all power supplies (VCC,
7371 * VCCQ, VCCQ2) can be turned off if power on write protect is not
7372 * required. If UFS link is inactive (Hibern8 or OFF state) and device
7373 * is in sleep state, put VCCQ & VCCQ2 rails in LPM mode.
7374 *
7375 * Ignore the error returned by ufshcd_toggle_vreg() as device is anyway
7376 * in low power state which would save some power.
7377 */
7386 }
7387 }
7388 }
7391 {
7405 }
7407 }
7410 vccq_lpm:
7412 vcc_disable:
7414 out:
7416 }
7419 {
7422 }
7425 {
7428 }
7430 /**
7431 * ufshcd_suspend - helper function for suspend operations
7432 * @hba: per adapter instance
7433 * @pm_op: desired low power operation type
7434 *
7435 * This function will try to put the UFS device and link into low power
7436 * mode based on the "rpm_lvl" (Runtime PM level) or "spm_lvl"
7437 * (System PM level).
7438 *
7439 * If this function is called during shutdown, it will make sure that
7440 * both UFS device and UFS link is powered off.
7441 *
7442 * NOTE: UFS device & link must be active before we enter in this function.
7443 *
7444 * Returns 0 for success and non-zero for failure
7445 */
7447 {
7462 }
7464 /*
7465 * If we can't transition into any of the low power modes
7466 * just gate the clocks.
7467 */
7475 }
7480 }
7486 /* UFS device & link must be active before we enter in this function */
7490 }
7494 /*
7495 * The device is idle with no requests in the queue,
7496 * allow background operations if bkops status shows
7497 * that performance might be impacted.
7498 */
7503 /* make sure that auto bkops is disabled */
7505 }
7506 }
7511 /* ensure that bkops is disabled */
7516 }
7524 disable_clks:
7525 /*
7526 * Call vendor specific suspend callback. As these callbacks may access
7527 * vendor specific host controller register space call them before the
7528 * host clocks are ON.
7529 */
7536 else
7537 /* If link is active, device ref_clk can't be switched off */
7542 /*
7543 * Disable the host irq as host controller as there won't be any
7544 * host controller transaction expected till resume.
7545 */
7547 /* Put the host controller in low power mode if possible */
7551 set_link_active:
7559 set_dev_active:
7562 enable_gating:
7567 out:
7570 }
7572 /**
7573 * ufshcd_resume - helper function for resume operations
7574 * @hba: per adapter instance
7575 * @pm_op: runtime PM or system PM
7576 *
7577 * This function basically brings the UFS device, UniPro link and controller
7578 * to active state.
7579 *
7580 * Returns 0 for success and non-zero for failure
7581 */
7583 {
7591 /* Make sure clocks are enabled before accessing controller */
7596 /* enable the host irq as host controller would be active soon */
7605 /*
7606 * Call vendor specific resume callback. As these callbacks may access
7607 * vendor specific host controller register space call them when the
7608 * host clocks are ON.
7609 */
7618 else
7622 /*
7623 * ufshcd_host_reset_and_restore() should have already
7624 * set the link state as active
7625 */
7628 }
7634 }
7638 else
7639 /*
7640 * If BKOPs operations are urgently needed at this moment then
7641 * keep auto-bkops enabled or else disable it.
7642 */
7650 /* Schedule clock gating in case of no access to UFS device yet */
7653 /* Enable Auto-Hibernate if configured */
7658 set_old_link_state:
7660 vendor_suspend:
7662 disable_vreg:
7664 disable_irq_and_vops_clks:
7669 out:
7672 }
7674 /**
7675 * ufshcd_system_suspend - system suspend routine
7676 * @hba: per adapter instance
7677 *
7678 * Check the description of ufshcd_suspend() function for more details.
7679 *
7680 * Returns 0 for success and non-zero for failure
7681 */
7683 {
7697 /*
7698 * UFS device and/or UFS link low power states during runtime
7699 * suspend seems to be different than what is expected during
7700 * system suspend. Hence runtime resume the devic & link and
7701 * let the system suspend low power states to take effect.
7702 * TODO: If resume takes longer time, we might have optimize
7703 * it in future by not resuming everything if possible.
7704 */
7708 }
7711 out:
7718 }
7721 /**
7722 * ufshcd_system_resume - system resume routine
7723 * @hba: per adapter instance
7724 *
7725 * Returns 0 for success and non-zero for failure
7726 */
7729 {
7737 /*
7738 * Let the runtime resume take care of resuming
7739 * if runtime suspended.
7740 */
7742 else
7744 out:
7749 }
7752 /**
7753 * ufshcd_runtime_suspend - runtime suspend routine
7754 * @hba: per adapter instance
7755 *
7756 * Check the description of ufshcd_suspend() function for more details.
7757 *
7758 * Returns 0 for success and non-zero for failure
7759 */
7761 {
7770 else
7772 out:
7777 }
7780 /**
7781 * ufshcd_runtime_resume - runtime resume routine
7782 * @hba: per adapter instance
7783 *
7784 * This function basically brings the UFS device, UniPro link and controller
7785 * to active state. Following operations are done in this function:
7786 *
7787 * 1. Turn on all the controller related clocks
7788 * 2. Bring the UniPro link out of Hibernate state
7789 * 3. If UFS device is in sleep state, turn ON VCC rail and bring the UFS device
7790 * to active state.
7791 * 4. If auto-bkops is enabled on the device, disable it.
7792 *
7793 * So following would be the possible power state after this function return
7794 * successfully:
7795 * S1: UFS device in Active state with VCC rail ON
7796 * UniPro link in Active state
7797 * All the UFS/UniPro controller clocks are ON
7798 *
7799 * Returns 0 for success and non-zero for failure
7800 */
7802 {
7811 else
7813 out:
7818 }
7822 {
7824 }
7827 /**
7828 * ufshcd_shutdown - shutdown routine
7829 * @hba: per adapter instance
7830 *
7831 * This function would power off both UFS device and UFS link.
7832 *
7833 * Returns 0 always to allow force shutdown even in case of errors.
7834 */
7836 {
7846 }
7849 out:
7852 /* allow force shutdown even in case of errors */
7854 }
7857 /**
7858 * ufshcd_remove - de-allocate SCSI host and host memory space
7859 * data structure memory
7860 * @hba: per adapter instance
7861 */
7863 {
7866 /* disable interrupts */
7874 }
7877 /**
7878 * ufshcd_dealloc_host - deallocate Host Bus Adapter (HBA)
7879 * @hba: pointer to Host Bus Adapter (HBA)
7880 */
7882 {
7884 }
7887 /**
7888 * ufshcd_set_dma_mask - Set dma mask based on the controller
7889 * addressing capability
7890 * @hba: per adapter instance
7891 *
7892 * Returns 0 for success, non-zero for failure
7893 */
7895 {
7899 }
7901 }
7903 /**
7904 * ufshcd_alloc_host - allocate Host Bus Adapter (HBA)
7905 * @dev: pointer to device handle
7906 * @hba_handle: driver private handle
7907 * Returns 0 on success, non-zero value on failure
7908 */
7910 {
7920 }
7928 }
7936 out_error:
7938 }
7941 /**
7942 * ufshcd_init - Driver initialization routine
7943 * @hba: per-adapter instance
7944 * @mmio_base: base register address
7945 * @irq: Interrupt line of device
7946 * Returns 0 on success, non-zero value on failure
7947 */
7949 {
7959 }
7964 /* Set descriptor lengths to specification defaults */
7971 /* Read capabilities registers */
7974 /* Get UFS version supported by the controller */
7984 /* Get Interrupt bit mask per version */
7991 }
7993 /* Allocate memory for host memory space */
7998 }
8000 /* Configure LRB */
8013 /* Initailize wait queue for task management */
8017 /* Initialize work queues */
8021 /* Initialize UIC command mutex */
8024 /* Initialize mutex for device management commands */
8029 /* Initialize device management tag acquire wait queue */
8034 /*
8035 * In order to avoid any spurious interrupt immediately after
8036 * registering UFS controller interrupt handler, clear any pending UFS
8037 * interrupt status and disable all the UFS interrupts.
8038 */
8040 REG_INTERRUPT_STATUS);
8042 /*
8043 * Make sure that UFS interrupts are disabled and any pending interrupt
8044 * status is cleared before registering UFS interrupt handler.
8045 */
8048 /* IRQ registration */
8055 }
8061 }
8063 /* Host controller enable */
8070 }
8076 ufshcd_clk_scaling_suspend_work);
8078 ufshcd_clk_scaling_resume_work);
8085 }
8087 /*
8088 * Set the default power management level for runtime and system PM.
8089 * Default power saving mode is to keep UFS link in Hibern8 state
8090 * and UFS device in sleep state.
8091 */
8093 UFS_SLEEP_PWR_MODE,
8094 UIC_LINK_HIBERN8_STATE);
8096 UFS_SLEEP_PWR_MODE,
8097 UIC_LINK_HIBERN8_STATE);
8099 /* Set the default auto-hiberate idle timer value to 150 ms */
8103 }
8105 /* Hold auto suspend until async scan completes */
8108 /*
8109 * We are assuming that device wasn't put in sleep/power-down
8110 * state exclusively during the boot stage before kernel.
8111 * This assumption helps avoid doing link startup twice during
8112 * ufshcd_probe_hba().
8113 */
8121 out_remove_scsi_host:
8123 exit_gating:
8125 out_disable:
8128 out_error:
8130 }