]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/mpr/mpr_mapping.c
Merge ACPICA 20170831.
[FreeBSD/FreeBSD.git] / sys / dev / mpr / mpr_mapping.c
1 /*-
2  * Copyright (c) 2011-2015 LSI Corp.
3  * Copyright (c) 2013-2016 Avago Technologies
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
28  */
29
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32
33 /* TODO Move headers to mprvar */
34 #include <sys/types.h>
35 #include <sys/param.h>
36 #include <sys/lock.h>
37 #include <sys/mutex.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/malloc.h>
41 #include <sys/kthread.h>
42 #include <sys/taskqueue.h>
43 #include <sys/bus.h>
44 #include <sys/endian.h>
45 #include <sys/sysctl.h>
46 #include <sys/eventhandler.h>
47 #include <sys/uio.h>
48 #include <machine/bus.h>
49 #include <machine/resource.h>
50 #include <dev/mpr/mpi/mpi2_type.h>
51 #include <dev/mpr/mpi/mpi2.h>
52 #include <dev/mpr/mpi/mpi2_ioc.h>
53 #include <dev/mpr/mpi/mpi2_sas.h>
54 #include <dev/mpr/mpi/mpi2_pci.h>
55 #include <dev/mpr/mpi/mpi2_cnfg.h>
56 #include <dev/mpr/mpi/mpi2_init.h>
57 #include <dev/mpr/mpi/mpi2_tool.h>
58 #include <dev/mpr/mpr_ioctl.h>
59 #include <dev/mpr/mprvar.h>
60 #include <dev/mpr/mpr_mapping.h>
61
62 /**
63  * _mapping_clear_map_entry - Clear a particular mapping entry.
64  * @map_entry: map table entry
65  *
66  * Returns nothing.
67  */
68 static inline void
69 _mapping_clear_map_entry(struct dev_mapping_table *map_entry)
70 {
71         map_entry->physical_id = 0;
72         map_entry->device_info = 0;
73         map_entry->phy_bits = 0;
74         map_entry->dpm_entry_num = MPR_DPM_BAD_IDX;
75         map_entry->dev_handle = 0;
76         map_entry->id = -1;
77         map_entry->missing_count = 0;
78         map_entry->init_complete = 0;
79         map_entry->TLR_bits = (u8)MPI2_SCSIIO_CONTROL_NO_TLR;
80 }
81
82 /**
83  * _mapping_clear_enc_entry - Clear a particular enclosure table entry.
84  * @enc_entry: enclosure table entry
85  *
86  * Returns nothing.
87  */
88 static inline void
89 _mapping_clear_enc_entry(struct enc_mapping_table *enc_entry)
90 {
91         enc_entry->enclosure_id = 0;
92         enc_entry->start_index = MPR_MAPTABLE_BAD_IDX;
93         enc_entry->phy_bits = 0;
94         enc_entry->dpm_entry_num = MPR_DPM_BAD_IDX;
95         enc_entry->enc_handle = 0;
96         enc_entry->num_slots = 0;
97         enc_entry->start_slot = 0;
98         enc_entry->missing_count = 0;
99         enc_entry->removal_flag = 0;
100         enc_entry->skip_search = 0;
101         enc_entry->init_complete = 0;
102 }
103
104 /**
105  * _mapping_commit_enc_entry - write a particular enc entry in DPM page0.
106  * @sc: per adapter object
107  * @enc_entry: enclosure table entry
108  *
109  * Returns 0 for success, non-zero for failure.
110  */
111 static int
112 _mapping_commit_enc_entry(struct mpr_softc *sc,
113     struct enc_mapping_table *et_entry)
114 {
115         Mpi2DriverMap0Entry_t *dpm_entry;
116         struct dev_mapping_table *mt_entry;
117         Mpi2ConfigReply_t mpi_reply;
118         Mpi2DriverMappingPage0_t config_page;
119
120         if (!sc->is_dpm_enable)
121                 return 0;
122
123         memset(&config_page, 0, sizeof(Mpi2DriverMappingPage0_t));
124         memcpy(&config_page.Header, (u8 *) sc->dpm_pg0,
125             sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
126         dpm_entry = (Mpi2DriverMap0Entry_t *)((u8 *)sc->dpm_pg0 +
127             sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
128         dpm_entry += et_entry->dpm_entry_num;
129         dpm_entry->PhysicalIdentifier.Low =
130             ( 0xFFFFFFFF & et_entry->enclosure_id);
131         dpm_entry->PhysicalIdentifier.High =
132             ( et_entry->enclosure_id >> 32);
133         mt_entry = &sc->mapping_table[et_entry->start_index];
134         dpm_entry->DeviceIndex = htole16(mt_entry->id);
135         dpm_entry->MappingInformation = et_entry->num_slots;
136         dpm_entry->MappingInformation <<= MPI2_DRVMAP0_MAPINFO_SLOT_SHIFT;
137         dpm_entry->MappingInformation |= et_entry->missing_count;
138         dpm_entry->MappingInformation = htole16(dpm_entry->MappingInformation);
139         dpm_entry->PhysicalBitsMapping = htole32(et_entry->phy_bits);
140         dpm_entry->Reserved1 = 0;
141
142         mpr_dprint(sc, MPR_MAPPING, "%s: Writing DPM entry %d for enclosure.\n",
143             __func__, et_entry->dpm_entry_num);
144         memcpy(&config_page.Entry, (u8 *)dpm_entry,
145             sizeof(Mpi2DriverMap0Entry_t));
146         if (mpr_config_set_dpm_pg0(sc, &mpi_reply, &config_page,
147             et_entry->dpm_entry_num)) {
148                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: Write of DPM "
149                     "entry %d for enclosure failed.\n", __func__,
150                     et_entry->dpm_entry_num);
151                 dpm_entry->MappingInformation = le16toh(dpm_entry->
152                     MappingInformation);
153                 dpm_entry->DeviceIndex = le16toh(dpm_entry->DeviceIndex);
154                 dpm_entry->PhysicalBitsMapping =
155                     le32toh(dpm_entry->PhysicalBitsMapping);
156                 return -1;
157         }
158         dpm_entry->MappingInformation = le16toh(dpm_entry->
159             MappingInformation);
160         dpm_entry->DeviceIndex = le16toh(dpm_entry->DeviceIndex);
161         dpm_entry->PhysicalBitsMapping =
162             le32toh(dpm_entry->PhysicalBitsMapping);
163         return 0;
164 }
165
166 /**
167  * _mapping_commit_map_entry - write a particular map table entry in DPM page0.
168  * @sc: per adapter object
169  * @mt_entry: mapping table entry
170  *
171  * Returns 0 for success, non-zero for failure.
172  */
173
174 static int
175 _mapping_commit_map_entry(struct mpr_softc *sc,
176     struct dev_mapping_table *mt_entry)
177 {
178         Mpi2DriverMap0Entry_t *dpm_entry;
179         Mpi2ConfigReply_t mpi_reply;
180         Mpi2DriverMappingPage0_t config_page;
181
182         if (!sc->is_dpm_enable)
183                 return 0;
184
185         /*
186          * It's possible that this Map Entry points to a BAD DPM index. This
187          * can happen if the Map Entry is a for a missing device and the DPM
188          * entry that was being used by this device is now being used by some
189          * new device. So, check for a BAD DPM index and just return if so.
190          */
191         if (mt_entry->dpm_entry_num == MPR_DPM_BAD_IDX) {
192                 mpr_dprint(sc, MPR_MAPPING, "%s: DPM entry location for target "
193                     "%d is invalid. DPM will not be written.\n", __func__,
194                     mt_entry->id);
195                 return 0;
196         }
197
198         memset(&config_page, 0, sizeof(Mpi2DriverMappingPage0_t));
199         memcpy(&config_page.Header, (u8 *)sc->dpm_pg0,
200             sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
201         dpm_entry = (Mpi2DriverMap0Entry_t *)((u8 *) sc->dpm_pg0 +
202             sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
203         dpm_entry = dpm_entry + mt_entry->dpm_entry_num;
204         dpm_entry->PhysicalIdentifier.Low = (0xFFFFFFFF &
205             mt_entry->physical_id);
206         dpm_entry->PhysicalIdentifier.High = (mt_entry->physical_id >> 32);
207         dpm_entry->DeviceIndex = htole16(mt_entry->id);
208         dpm_entry->MappingInformation = htole16(mt_entry->missing_count);
209         dpm_entry->PhysicalBitsMapping = 0;
210         dpm_entry->Reserved1 = 0;
211         memcpy(&config_page.Entry, (u8 *)dpm_entry,
212             sizeof(Mpi2DriverMap0Entry_t));
213
214         mpr_dprint(sc, MPR_MAPPING, "%s: Writing DPM entry %d for target %d.\n",
215             __func__, mt_entry->dpm_entry_num, mt_entry->id);
216         if (mpr_config_set_dpm_pg0(sc, &mpi_reply, &config_page,
217             mt_entry->dpm_entry_num)) {
218                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: Write of DPM "
219                     "entry %d for target %d failed.\n", __func__,
220                     mt_entry->dpm_entry_num, mt_entry->id);
221                 dpm_entry->MappingInformation = le16toh(dpm_entry->
222                     MappingInformation);
223                 dpm_entry->DeviceIndex = le16toh(dpm_entry->DeviceIndex);
224                 return -1;
225         }
226
227         dpm_entry->MappingInformation = le16toh(dpm_entry->MappingInformation);
228         dpm_entry->DeviceIndex = le16toh(dpm_entry->DeviceIndex);
229         return 0;
230 }
231
232 /**
233  * _mapping_get_ir_maprange - get start and end index for IR map range.
234  * @sc: per adapter object
235  * @start_idx: place holder for start index
236  * @end_idx: place holder for end index
237  *
238  * The IR volumes can be mapped either at start or end of the mapping table
239  * this function gets the detail of where IR volume mapping starts and ends
240  * in the device mapping table
241  *
242  * Returns nothing.
243  */
244 static void
245 _mapping_get_ir_maprange(struct mpr_softc *sc, u32 *start_idx, u32 *end_idx)
246 {
247         u16 volume_mapping_flags;
248         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
249
250         volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
251             MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
252         if (volume_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING) {
253                 *start_idx = 0;
254                 if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
255                         *start_idx = 1;
256         } else
257                 *start_idx = sc->max_devices - sc->max_volumes;
258         *end_idx = *start_idx + sc->max_volumes - 1;
259 }
260
261 /**
262  * _mapping_get_enc_idx_from_id - get enclosure index from enclosure ID
263  * @sc: per adapter object
264  * @enc_id: enclosure logical identifier
265  *
266  * Returns the index of enclosure entry on success or bad index.
267  */
268 static u8
269 _mapping_get_enc_idx_from_id(struct mpr_softc *sc, u64 enc_id,
270     u64 phy_bits)
271 {
272         struct enc_mapping_table *et_entry;
273         u8 enc_idx = 0;
274
275         for (enc_idx = 0; enc_idx < sc->num_enc_table_entries; enc_idx++) {
276                 et_entry = &sc->enclosure_table[enc_idx];
277                 if ((et_entry->enclosure_id == le64toh(enc_id)) &&
278                     (!et_entry->phy_bits || (et_entry->phy_bits &
279                     le32toh(phy_bits))))
280                         return enc_idx;
281         }
282         return MPR_ENCTABLE_BAD_IDX;
283 }
284
285 /**
286  * _mapping_get_enc_idx_from_handle - get enclosure index from handle
287  * @sc: per adapter object
288  * @enc_id: enclosure handle
289  *
290  * Returns the index of enclosure entry on success or bad index.
291  */
292 static u8
293 _mapping_get_enc_idx_from_handle(struct mpr_softc *sc, u16 handle)
294 {
295         struct enc_mapping_table *et_entry;
296         u8 enc_idx = 0;
297
298         for (enc_idx = 0; enc_idx < sc->num_enc_table_entries; enc_idx++) {
299                 et_entry = &sc->enclosure_table[enc_idx];
300                 if (et_entry->missing_count)
301                         continue;
302                 if (et_entry->enc_handle == handle)
303                         return enc_idx;
304         }
305         return MPR_ENCTABLE_BAD_IDX;
306 }
307
308 /**
309  * _mapping_get_high_missing_et_idx - get missing enclosure index
310  * @sc: per adapter object
311  *
312  * Search through the enclosure table and identifies the enclosure entry
313  * with high missing count and returns it's index
314  *
315  * Returns the index of enclosure entry on success or bad index.
316  */
317 static u8
318 _mapping_get_high_missing_et_idx(struct mpr_softc *sc)
319 {
320         struct enc_mapping_table *et_entry;
321         u8 high_missing_count = 0;
322         u8 enc_idx, high_idx = MPR_ENCTABLE_BAD_IDX;
323
324         for (enc_idx = 0; enc_idx < sc->num_enc_table_entries; enc_idx++) {
325                 et_entry = &sc->enclosure_table[enc_idx];
326                 if ((et_entry->missing_count > high_missing_count) &&
327                     !et_entry->skip_search) {
328                         high_missing_count = et_entry->missing_count;
329                         high_idx = enc_idx;
330                 }
331         }
332         return high_idx;
333 }
334
335 /**
336  * _mapping_get_high_missing_mt_idx - get missing map table index
337  * @sc: per adapter object
338  *
339  * Search through the map table and identifies the device entry
340  * with high missing count and returns it's index
341  *
342  * Returns the index of map table entry on success or bad index.
343  */
344 static u32
345 _mapping_get_high_missing_mt_idx(struct mpr_softc *sc)
346 {
347         u32 map_idx, high_idx = MPR_MAPTABLE_BAD_IDX;
348         u8 high_missing_count = 0;
349         u32 start_idx, end_idx, start_idx_ir, end_idx_ir;
350         struct dev_mapping_table *mt_entry;
351         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
352
353         start_idx = 0;
354         start_idx_ir = 0;
355         end_idx_ir = 0;
356         end_idx = sc->max_devices;
357         if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
358                 start_idx = 1;
359         if (sc->ir_firmware) {
360                 _mapping_get_ir_maprange(sc, &start_idx_ir, &end_idx_ir);
361                 if (start_idx == start_idx_ir)
362                         start_idx = end_idx_ir + 1;
363                 else
364                         end_idx = start_idx_ir;
365         }
366         mt_entry = &sc->mapping_table[start_idx];
367         for (map_idx = start_idx; map_idx < end_idx; map_idx++, mt_entry++) {
368                 if (mt_entry->missing_count > high_missing_count) {
369                         high_missing_count =  mt_entry->missing_count;
370                         high_idx = map_idx;
371                 }
372         }
373         return high_idx;
374 }
375
376 /**
377  * _mapping_get_ir_mt_idx_from_wwid - get map table index from volume WWID
378  * @sc: per adapter object
379  * @wwid: world wide unique ID of the volume
380  *
381  * Returns the index of map table entry on success or bad index.
382  */
383 static u32
384 _mapping_get_ir_mt_idx_from_wwid(struct mpr_softc *sc, u64 wwid)
385 {
386         u32 start_idx, end_idx, map_idx;
387         struct dev_mapping_table *mt_entry;
388
389         _mapping_get_ir_maprange(sc, &start_idx, &end_idx);
390         mt_entry = &sc->mapping_table[start_idx];
391         for (map_idx = start_idx; map_idx <= end_idx; map_idx++, mt_entry++)
392                 if (mt_entry->physical_id == wwid)
393                         return map_idx;
394
395         return MPR_MAPTABLE_BAD_IDX;
396 }
397
398 /**
399  * _mapping_get_mt_idx_from_id - get map table index from a device ID
400  * @sc: per adapter object
401  * @dev_id: device identifer (SAS Address)
402  *
403  * Returns the index of map table entry on success or bad index.
404  */
405 static u32
406 _mapping_get_mt_idx_from_id(struct mpr_softc *sc, u64 dev_id)
407 {
408         u32 map_idx;
409         struct dev_mapping_table *mt_entry;
410
411         for (map_idx = 0; map_idx < sc->max_devices; map_idx++) {
412                 mt_entry = &sc->mapping_table[map_idx];
413                 if (mt_entry->physical_id == dev_id)
414                         return map_idx;
415         }
416         return MPR_MAPTABLE_BAD_IDX;
417 }
418
419 /**
420  * _mapping_get_ir_mt_idx_from_handle - get map table index from volume handle
421  * @sc: per adapter object
422  * @wwid: volume device handle
423  *
424  * Returns the index of map table entry on success or bad index.
425  */
426 static u32
427 _mapping_get_ir_mt_idx_from_handle(struct mpr_softc *sc, u16 volHandle)
428 {
429         u32 start_idx, end_idx, map_idx;
430         struct dev_mapping_table *mt_entry;
431
432         _mapping_get_ir_maprange(sc, &start_idx, &end_idx);
433         mt_entry = &sc->mapping_table[start_idx];
434         for (map_idx = start_idx; map_idx <= end_idx; map_idx++, mt_entry++)
435                 if (mt_entry->dev_handle == volHandle)
436                         return map_idx;
437
438         return MPR_MAPTABLE_BAD_IDX;
439 }
440
441 /**
442  * _mapping_get_mt_idx_from_handle - get map table index from handle
443  * @sc: per adapter object
444  * @dev_id: device handle
445  *
446  * Returns the index of map table entry on success or bad index.
447  */
448 static u32
449 _mapping_get_mt_idx_from_handle(struct mpr_softc *sc, u16 handle)
450 {
451         u32 map_idx;
452         struct dev_mapping_table *mt_entry;
453
454         for (map_idx = 0; map_idx < sc->max_devices; map_idx++) {
455                 mt_entry = &sc->mapping_table[map_idx];
456                 if (mt_entry->dev_handle == handle)
457                         return map_idx;
458         }
459         return MPR_MAPTABLE_BAD_IDX;
460 }
461
462 /**
463  * _mapping_get_free_ir_mt_idx - get first free index for a volume
464  * @sc: per adapter object
465  *
466  * Search through mapping table for free index for a volume and if no free
467  * index then looks for a volume with high mapping index
468  *
469  * Returns the index of map table entry on success or bad index.
470  */
471 static u32
472 _mapping_get_free_ir_mt_idx(struct mpr_softc *sc)
473 {
474         u8 high_missing_count = 0;
475         u32 start_idx, end_idx, map_idx;
476         u32 high_idx = MPR_MAPTABLE_BAD_IDX;
477         struct dev_mapping_table *mt_entry;
478
479         /*
480          * The IN_USE flag should be clear if the entry is available to use.
481          * This flag is cleared on initialization and and when a volume is
482          * deleted. All other times this flag should be set. If, for some
483          * reason, a free entry cannot be found, look for the entry with the
484          * highest missing count just in case there is one.
485          */
486         _mapping_get_ir_maprange(sc, &start_idx, &end_idx);
487         mt_entry = &sc->mapping_table[start_idx];
488         for (map_idx = start_idx; map_idx <= end_idx; map_idx++, mt_entry++) {
489                 if (!(mt_entry->device_info & MPR_MAP_IN_USE))
490                         return map_idx;
491
492                 if (mt_entry->missing_count > high_missing_count) {
493                         high_missing_count = mt_entry->missing_count;
494                         high_idx = map_idx;
495                 }
496         }
497
498         if (high_idx == MPR_MAPTABLE_BAD_IDX) {
499                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: Could not find a "
500                     "free entry in the mapping table for a Volume. The mapping "
501                     "table is probably corrupt.\n", __func__);
502         }
503         
504         return high_idx;
505 }
506
507 /**
508  * _mapping_get_free_mt_idx - get first free index for a device
509  * @sc: per adapter object
510  * @start_idx: offset in the table to start search
511  *
512  * Returns the index of map table entry on success or bad index.
513  */
514 static u32
515 _mapping_get_free_mt_idx(struct mpr_softc *sc, u32 start_idx)
516 {
517         u32 map_idx, max_idx = sc->max_devices;
518         struct dev_mapping_table *mt_entry = &sc->mapping_table[start_idx];
519         u16 volume_mapping_flags;
520
521         volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
522             MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
523         if (sc->ir_firmware && (volume_mapping_flags ==
524             MPI2_IOCPAGE8_IRFLAGS_HIGH_VOLUME_MAPPING))
525                 max_idx -= sc->max_volumes;
526
527         for (map_idx  = start_idx; map_idx < max_idx; map_idx++, mt_entry++)
528                 if (!(mt_entry->device_info & (MPR_MAP_IN_USE |
529                     MPR_DEV_RESERVED)))
530                         return map_idx;
531
532         return MPR_MAPTABLE_BAD_IDX;
533 }
534
535 /**
536  * _mapping_get_dpm_idx_from_id - get DPM index from ID
537  * @sc: per adapter object
538  * @id: volume WWID or enclosure ID or device ID
539  *
540  * Returns the index of DPM entry on success or bad index.
541  */
542 static u16
543 _mapping_get_dpm_idx_from_id(struct mpr_softc *sc, u64 id, u32 phy_bits)
544 {
545         u16 entry_num;
546         uint64_t PhysicalIdentifier;
547         Mpi2DriverMap0Entry_t *dpm_entry;
548
549         dpm_entry = (Mpi2DriverMap0Entry_t *)((u8 *)sc->dpm_pg0 +
550             sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
551         PhysicalIdentifier = dpm_entry->PhysicalIdentifier.High;
552         PhysicalIdentifier = (PhysicalIdentifier << 32) | 
553             dpm_entry->PhysicalIdentifier.Low;
554         for (entry_num = 0; entry_num < sc->max_dpm_entries; entry_num++,
555             dpm_entry++)
556                 if ((id == PhysicalIdentifier) &&
557                     (!phy_bits || !dpm_entry->PhysicalBitsMapping ||
558                     (phy_bits & dpm_entry->PhysicalBitsMapping)))
559                         return entry_num;
560
561         return MPR_DPM_BAD_IDX;
562 }
563
564
565 /**
566  * _mapping_get_free_dpm_idx - get first available DPM index
567  * @sc: per adapter object
568  *
569  * Returns the index of DPM entry on success or bad index.
570  */
571 static u32
572 _mapping_get_free_dpm_idx(struct mpr_softc *sc)
573 {
574         u16 entry_num;
575         Mpi2DriverMap0Entry_t *dpm_entry;
576         u16 current_entry = MPR_DPM_BAD_IDX, missing_cnt, high_missing_cnt = 0;
577         u64 physical_id;
578         struct dev_mapping_table *mt_entry;
579         u32 map_idx;
580
581         for (entry_num = 0; entry_num < sc->max_dpm_entries; entry_num++) {
582                 dpm_entry = (Mpi2DriverMap0Entry_t *) ((u8 *)sc->dpm_pg0 +
583                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
584                 dpm_entry += entry_num;
585                 missing_cnt = dpm_entry->MappingInformation &
586                     MPI2_DRVMAP0_MAPINFO_MISSING_MASK;
587
588                 /*
589                  * If entry is used and not missing, then this entry can't be
590                  * used. Look at next one.
591                  */
592                 if (sc->dpm_entry_used[entry_num] && !missing_cnt)
593                         continue;
594
595                 /*
596                  * If this entry is not used at all, then the missing count
597                  * doesn't matter. Just use this one. Otherwise, keep looking
598                  * and make sure the entry with the highest missing count is
599                  * used.
600                  */
601                 if (!sc->dpm_entry_used[entry_num]) {
602                         current_entry = entry_num;
603                         break;
604                 }
605                 if ((current_entry == MPR_DPM_BAD_IDX) ||
606                     (missing_cnt > high_missing_cnt)) {
607                         current_entry = entry_num;
608                         high_missing_cnt = missing_cnt;
609                 }
610         }
611
612         /*
613          * If an entry has been found to use and it's already marked as used
614          * it means that some device was already using this entry but it's
615          * missing, and that means that the connection between the missing
616          * device's DPM entry and the mapping table needs to be cleared. To do
617          * this, use the Physical ID of the old device still in the DPM entry
618          * to find its mapping table entry, then mark its DPM entry as BAD.
619          */
620         if ((current_entry != MPR_DPM_BAD_IDX) &&
621             sc->dpm_entry_used[current_entry]) {
622                 dpm_entry = (Mpi2DriverMap0Entry_t *) ((u8 *)sc->dpm_pg0 +
623                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
624                 dpm_entry += current_entry;
625                 physical_id = dpm_entry->PhysicalIdentifier.High;
626                 physical_id = (physical_id << 32) |
627                     dpm_entry->PhysicalIdentifier.Low;
628                 map_idx = _mapping_get_mt_idx_from_id(sc, physical_id);
629                 if (map_idx != MPR_MAPTABLE_BAD_IDX) {
630                         mt_entry = &sc->mapping_table[map_idx];
631                         mt_entry->dpm_entry_num = MPR_DPM_BAD_IDX;
632                 }
633         }
634         return current_entry;
635 }
636
637 /**
638  * _mapping_update_ir_missing_cnt - Updates missing count for a volume
639  * @sc: per adapter object
640  * @map_idx: map table index of the volume
641  * @element: IR configuration change element
642  * @wwid: IR volume ID.
643  *
644  * Updates the missing count in the map table and in the DPM entry for a volume
645  *
646  * Returns nothing.
647  */
648 static void
649 _mapping_update_ir_missing_cnt(struct mpr_softc *sc, u32 map_idx,
650     Mpi2EventIrConfigElement_t *element, u64 wwid)
651 {
652         struct dev_mapping_table *mt_entry;
653         u8 missing_cnt, reason = element->ReasonCode, update_dpm = 1;
654         u16 dpm_idx;
655         Mpi2DriverMap0Entry_t *dpm_entry;
656
657         /*
658          * Depending on the reason code, update the missing count. Always set
659          * the init_complete flag when here, so just do it first. That flag is
660          * used for volumes to make sure that the DPM entry has been updated.
661          * When a volume is deleted, clear the map entry's IN_USE flag so that
662          * the entry can be used again if another volume is created. Also clear
663          * its dev_handle entry so that other functions can't find this volume
664          * by the handle, since it's not defined any longer.
665          */
666         mt_entry = &sc->mapping_table[map_idx];
667         mt_entry->init_complete = 1;
668         if ((reason == MPI2_EVENT_IR_CHANGE_RC_ADDED) ||
669             (reason == MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED)) {
670                 mt_entry->missing_count = 0;
671         } else if (reason == MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED) {
672                 if (mt_entry->missing_count < MPR_MAX_MISSING_COUNT)
673                         mt_entry->missing_count++;
674
675                 mt_entry->device_info &= ~MPR_MAP_IN_USE;
676                 mt_entry->dev_handle = 0;
677         }
678
679         /*
680          * If persistent mapping is enabled, update the DPM with the new missing
681          * count for the volume. If the DPM index is bad, get a free one. If
682          * it's bad for a volume that's being deleted do nothing because that
683          * volume doesn't have a DPM entry. 
684          */
685         if (!sc->is_dpm_enable)
686                 return;
687         dpm_idx = mt_entry->dpm_entry_num;
688         if (dpm_idx == MPR_DPM_BAD_IDX) {
689                 if (reason == MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED)
690                 {
691                         mpr_dprint(sc, MPR_MAPPING, "%s: Volume being deleted "
692                             "is not in DPM so DPM missing count will not be "
693                             "updated.\n", __func__);
694                         return;
695                 }
696         }
697         if (dpm_idx == MPR_DPM_BAD_IDX)
698                 dpm_idx = _mapping_get_free_dpm_idx(sc);
699
700         /*
701          * Got the DPM entry for the volume or found a free DPM entry if this is
702          * a new volume. Check if the current information is outdated.
703          */
704         if (dpm_idx != MPR_DPM_BAD_IDX) {
705                 dpm_entry = (Mpi2DriverMap0Entry_t *)((u8 *)sc->dpm_pg0 +
706                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
707                 dpm_entry += dpm_idx;
708                 missing_cnt = dpm_entry->MappingInformation &
709                     MPI2_DRVMAP0_MAPINFO_MISSING_MASK;
710                 if ((mt_entry->physical_id ==
711                     le64toh(((u64)dpm_entry->PhysicalIdentifier.High << 32) |
712                     (u64)dpm_entry->PhysicalIdentifier.Low)) && (missing_cnt ==
713                     mt_entry->missing_count)) {
714                         mpr_dprint(sc, MPR_MAPPING, "%s: DPM entry for volume "
715                            "with target ID %d does not require an update.\n",
716                             __func__, mt_entry->id);
717                         update_dpm = 0;
718                 }
719         }
720
721         /*
722          * Update the volume's persistent info if it's new or the ID or missing
723          * count has changed. If a good DPM index has not been found by now,
724          * there is no space left in the DPM table.
725          */
726         if ((dpm_idx != MPR_DPM_BAD_IDX) && update_dpm) {
727                 mpr_dprint(sc, MPR_MAPPING, "%s: Update DPM entry for volume "
728                     "with target ID %d.\n", __func__, mt_entry->id);
729                 mt_entry->dpm_entry_num = dpm_idx;
730                 dpm_entry = (Mpi2DriverMap0Entry_t *)((u8 *)sc->dpm_pg0 +
731                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
732                 dpm_entry += dpm_idx;
733                 dpm_entry->PhysicalIdentifier.Low =
734                     (0xFFFFFFFF & mt_entry->physical_id);
735                 dpm_entry->PhysicalIdentifier.High =
736                     (mt_entry->physical_id >> 32);
737                 dpm_entry->DeviceIndex = map_idx;
738                 dpm_entry->MappingInformation = mt_entry->missing_count;
739                 dpm_entry->PhysicalBitsMapping = 0;
740                 dpm_entry->Reserved1 = 0;
741                 sc->dpm_flush_entry[dpm_idx] = 1;
742                 sc->dpm_entry_used[dpm_idx] = 1;
743         } else if (dpm_idx == MPR_DPM_BAD_IDX) {
744                 mpr_dprint(sc, MPR_INFO | MPR_MAPPING, "%s: No space to add an "
745                     "entry in the DPM table for volume with target ID %d.\n",
746                     __func__, mt_entry->id);
747         }
748 }
749
750 /**
751  * _mapping_add_to_removal_table - add DPM index to the removal table
752  * @sc: per adapter object
753  * @dpm_idx: Index of DPM entry to remove
754  *
755  * Adds a DPM entry number to the removal table.
756  *
757  * Returns nothing.
758  */
759 static void
760 _mapping_add_to_removal_table(struct mpr_softc *sc, u16 dpm_idx)
761 {
762         struct map_removal_table *remove_entry;
763         u32 i;
764
765         /*
766          * This is only used to remove entries from the DPM in the controller.
767          * If DPM is not enabled, just return.
768          */
769         if (!sc->is_dpm_enable)
770                 return;
771
772         /*
773          * Find the first available removal_table entry and add the new entry
774          * there.
775          */
776         remove_entry = sc->removal_table;
777         for (i = 0; i < sc->max_devices; i++, remove_entry++) {
778                 if (remove_entry->dpm_entry_num != MPR_DPM_BAD_IDX)
779                         continue;
780  
781                 mpr_dprint(sc, MPR_MAPPING, "%s: Adding DPM entry %d to table "
782                     "for removal.\n", __func__, dpm_idx);
783                 remove_entry->dpm_entry_num = dpm_idx;
784                 break;
785         }
786
787 }
788
789 /**
790  * _mapping_inc_missing_count
791  * @sc: per adapter object
792  * @map_idx: index into the mapping table for the device that is missing 
793  *
794  * Increment the missing count in the mapping table for a SAS, SATA, or PCIe
795  * device that is not responding. If Persitent Mapping is used, increment the
796  * DPM entry as well. Currently, this function is only called if the target
797  * goes missing, so after initialization has completed. This means that the
798  * missing count can only go from 0 to 1 here. The missing count is incremented
799  * during initialization as well, so that's where a target's missing count can
800  * go past 1.
801  *
802  * Returns nothing.
803  */
804 static void
805 _mapping_inc_missing_count(struct mpr_softc *sc, u32 map_idx)
806 {
807         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
808         struct dev_mapping_table *mt_entry;
809         Mpi2DriverMap0Entry_t *dpm_entry;
810
811         if (map_idx == MPR_MAPTABLE_BAD_IDX) {
812                 mpr_dprint(sc, MPR_INFO | MPR_MAPPING, "%s: device is already "
813                     "removed from mapping table\n", __func__);
814                 return;
815         }
816         mt_entry = &sc->mapping_table[map_idx];
817         if (mt_entry->missing_count < MPR_MAX_MISSING_COUNT)
818                 mt_entry->missing_count++;
819
820         /*
821          * When using Enc/Slot mapping, when a device is removed, it's mapping
822          * table information should be cleared. Otherwise, the target ID will
823          * be incorrect if this same device is re-added to a different slot.
824          */
825         if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
826             MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
827                 _mapping_clear_map_entry(mt_entry);
828         }
829
830         /*
831          * When using device mapping, update the missing count in the DPM entry,
832          * but only if the missing count has changed.
833          */
834         if (((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
835             MPI2_IOCPAGE8_FLAGS_DEVICE_PERSISTENCE_MAPPING) &&
836             sc->is_dpm_enable &&
837             mt_entry->dpm_entry_num != MPR_DPM_BAD_IDX) {
838                 dpm_entry = (Mpi2DriverMap0Entry_t *) ((u8 *)sc->dpm_pg0 +
839                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
840                 dpm_entry += mt_entry->dpm_entry_num;
841                 if (dpm_entry->MappingInformation != mt_entry->missing_count) {
842                         dpm_entry->MappingInformation = mt_entry->missing_count;
843                         sc->dpm_flush_entry[mt_entry->dpm_entry_num] = 1;
844                 }
845         }
846 }
847
848 /**
849  * _mapping_update_missing_count - Update missing count for a device
850  * @sc: per adapter object
851  * @topo_change: Topology change event entry
852  *
853  * Search through the topology change list and if any device is found not
854  * responding it's associated map table entry and DPM entry is updated
855  *
856  * Returns nothing.
857  */
858 static void
859 _mapping_update_missing_count(struct mpr_softc *sc,
860     struct _map_topology_change *topo_change)
861 {
862         u8 entry;
863         struct _map_phy_change *phy_change;
864         u32 map_idx;
865
866         for (entry = 0; entry < topo_change->num_entries; entry++) {
867                 phy_change = &topo_change->phy_details[entry];
868                 if (!phy_change->dev_handle || (phy_change->reason !=
869                     MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING))
870                         continue;
871                 map_idx = _mapping_get_mt_idx_from_handle(sc, phy_change->
872                     dev_handle);
873                 phy_change->is_processed = 1;
874                 _mapping_inc_missing_count(sc, map_idx);
875         }
876 }
877
878 /**
879  * _mapping_update_pcie_missing_count - Update missing count for a PCIe device
880  * @sc: per adapter object
881  * @topo_change: Topology change event entry
882  *
883  * Search through the PCIe topology change list and if any device is found not
884  * responding it's associated map table entry and DPM entry is updated
885  *
886  * Returns nothing.
887  */
888 static void
889 _mapping_update_pcie_missing_count(struct mpr_softc *sc,
890     struct _map_pcie_topology_change *topo_change)
891 {
892         u8 entry;
893         struct _map_port_change *port_change;
894         u32 map_idx;
895
896         for (entry = 0; entry < topo_change->num_entries; entry++) {
897                 port_change = &topo_change->port_details[entry];
898                 if (!port_change->dev_handle || (port_change->reason !=
899                     MPI26_EVENT_PCIE_TOPO_PS_NOT_RESPONDING))
900                         continue;
901                 map_idx = _mapping_get_mt_idx_from_handle(sc, port_change->
902                     dev_handle);
903                 port_change->is_processed = 1;
904                 _mapping_inc_missing_count(sc, map_idx);
905         }
906 }
907
908 /**
909  * _mapping_find_enc_map_space -find map table entries for enclosure
910  * @sc: per adapter object
911  * @et_entry: enclosure entry
912  *
913  * Search through the mapping table defragment it and provide contiguous
914  * space in map table for a particular enclosure entry
915  *
916  * Returns start index in map table or bad index.
917  */
918 static u32
919 _mapping_find_enc_map_space(struct mpr_softc *sc,
920     struct enc_mapping_table *et_entry)
921 {
922         u16 vol_mapping_flags;
923         u32 skip_count, end_of_table, map_idx, enc_idx;
924         u16 num_found;
925         u32 start_idx = MPR_MAPTABLE_BAD_IDX;
926         struct dev_mapping_table *mt_entry;
927         struct enc_mapping_table *enc_entry;
928         unsigned char done_flag = 0, found_space;
929         u16 max_num_phy_ids = le16toh(sc->ioc_pg8.MaxNumPhysicalMappedIDs);
930
931         skip_count = sc->num_rsvd_entries;
932         num_found = 0;
933
934         vol_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
935             MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
936
937         /*
938          * The end of the mapping table depends on where volumes are kept, if
939          * IR is enabled.
940          */
941         if (!sc->ir_firmware)
942                 end_of_table = sc->max_devices;
943         else if (vol_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING)
944                 end_of_table = sc->max_devices;
945         else
946                 end_of_table = sc->max_devices - sc->max_volumes;
947
948         /*
949          * The skip_count is the number of entries that are reserved at the
950          * beginning of the mapping table. But, it does not include the number
951          * of Physical IDs that are reserved for direct attached devices. Look
952          * through the mapping table after these reserved entries to see if 
953          * the devices for this enclosure are already mapped. The PHY bit check
954          * is used to make sure that at least one PHY bit is common between the
955          * enclosure and the device that is already mapped.
956          */
957         mpr_dprint(sc, MPR_MAPPING, "%s: Looking for space in the mapping "
958             "table for added enclosure.\n", __func__);
959         for (map_idx = (max_num_phy_ids + skip_count);
960             map_idx < end_of_table; map_idx++) {
961                 mt_entry = &sc->mapping_table[map_idx];
962                 if ((et_entry->enclosure_id == mt_entry->physical_id) &&
963                     (!mt_entry->phy_bits || (mt_entry->phy_bits &
964                     et_entry->phy_bits))) {
965                         num_found += 1;
966                         if (num_found == et_entry->num_slots) {
967                                 start_idx = (map_idx - num_found) + 1;
968                                 mpr_dprint(sc, MPR_MAPPING, "%s: Found space "
969                                     "in the mapping for enclosure at map index "
970                                     "%d.\n", __func__, start_idx);
971                                 return start_idx;
972                         }
973                 } else
974                         num_found = 0;
975         }
976
977         /*
978          * If the enclosure's devices are not mapped already, look for
979          * contiguous entries in the mapping table that are not reserved. If
980          * enough entries are found, return the starting index for that space.
981          */
982         num_found = 0;
983         for (map_idx = (max_num_phy_ids + skip_count);
984             map_idx < end_of_table; map_idx++) {
985                 mt_entry = &sc->mapping_table[map_idx];
986                 if (!(mt_entry->device_info & MPR_DEV_RESERVED)) {
987                         num_found += 1;
988                         if (num_found == et_entry->num_slots) {
989                                 start_idx = (map_idx - num_found) + 1;
990                                 mpr_dprint(sc, MPR_MAPPING, "%s: Found space "
991                                     "in the mapping for enclosure at map index "
992                                     "%d.\n", __func__, start_idx);
993                                 return start_idx;
994                         }
995                 } else
996                         num_found = 0;
997         }
998
999         /*
1000          * If here, it means that not enough space in the mapping table was
1001          * found to support this enclosure, so go through the enclosure table to
1002          * see if any enclosure entries have a missing count. If so, get the
1003          * enclosure with the highest missing count and check it to see if there
1004          * is enough space for the new enclosure.
1005          */
1006         while (!done_flag) {
1007                 enc_idx = _mapping_get_high_missing_et_idx(sc);
1008                 if (enc_idx == MPR_ENCTABLE_BAD_IDX) {
1009                         mpr_dprint(sc, MPR_MAPPING, "%s: Not enough space was "
1010                             "found in the mapping for the added enclosure.\n",
1011                             __func__);
1012                         return MPR_MAPTABLE_BAD_IDX;
1013                 }
1014
1015                 /*
1016                  * Found a missing enclosure. Set the skip_search flag so this
1017                  * enclosure is not checked again for a high missing count if
1018                  * the loop continues. This way, all missing enclosures can
1019                  * have their space added together to find enough space in the
1020                  * mapping table for the added enclosure. The space must be
1021                  * contiguous.
1022                  */
1023                 mpr_dprint(sc, MPR_MAPPING, "%s: Space from a missing "
1024                     "enclosure was found.\n", __func__);
1025                 enc_entry = &sc->enclosure_table[enc_idx];
1026                 enc_entry->skip_search = 1;
1027
1028                 /*
1029                  * Unmark all of the missing enclosure's device's reserved
1030                  * space. These will be remarked as reserved if this missing
1031                  * enclosure's space is not used.
1032                  */
1033                 mpr_dprint(sc, MPR_MAPPING, "%s: Clear the reserved flag for "
1034                     "all of the map entries for the enclosure.\n", __func__);
1035                 mt_entry = &sc->mapping_table[enc_entry->start_index];
1036                 for (map_idx = enc_entry->start_index; map_idx <
1037                     (enc_entry->start_index + enc_entry->num_slots); map_idx++,
1038                     mt_entry++)
1039                         mt_entry->device_info &= ~MPR_DEV_RESERVED;
1040
1041                 /*
1042                  * Now that space has been unreserved, check again to see if
1043                  * enough space is available for the new enclosure.
1044                  */
1045                 mpr_dprint(sc, MPR_MAPPING, "%s: Check if new mapping space is "
1046                     "enough for the new enclosure.\n", __func__);
1047                 found_space = 0;
1048                 num_found = 0;
1049                 for (map_idx = (max_num_phy_ids + skip_count);
1050                     map_idx < end_of_table; map_idx++) {
1051                         mt_entry = &sc->mapping_table[map_idx];
1052                         if (!(mt_entry->device_info & MPR_DEV_RESERVED)) {
1053                                 num_found += 1;
1054                                 if (num_found == et_entry->num_slots) {
1055                                         start_idx = (map_idx - num_found) + 1;
1056                                         found_space = 1;
1057                                         break;
1058                                 }
1059                         } else
1060                                 num_found = 0;
1061                 }
1062                 if (!found_space)
1063                         continue;
1064
1065                 /*
1066                  * If enough space was found, all of the missing enclosures that
1067                  * will be used for the new enclosure must be added to the
1068                  * removal table. Then all mappings for the enclosure's devices
1069                  * and for the enclosure itself need to be cleared. There may be
1070                  * more than one enclosure to add to the removal table and
1071                  * clear.
1072                  */
1073                 mpr_dprint(sc, MPR_MAPPING, "%s: Found space in the mapping "
1074                     "for enclosure at map index %d.\n", __func__, start_idx);
1075                 for (map_idx = start_idx; map_idx < (start_idx + num_found);
1076                     map_idx++) {
1077                         enc_entry = sc->enclosure_table;
1078                         for (enc_idx = 0; enc_idx < sc->num_enc_table_entries;
1079                             enc_idx++, enc_entry++) {
1080                                 if (map_idx < enc_entry->start_index ||
1081                                     map_idx > (enc_entry->start_index +
1082                                     enc_entry->num_slots))
1083                                         continue;
1084                                 if (!enc_entry->removal_flag) {
1085                                         mpr_dprint(sc, MPR_MAPPING, "%s: "
1086                                             "Enclosure %d will be removed from "
1087                                             "the mapping table.\n", __func__,
1088                                             enc_idx);
1089                                         enc_entry->removal_flag = 1;
1090                                         _mapping_add_to_removal_table(sc,
1091                                             enc_entry->dpm_entry_num);
1092                                 }
1093                                 mt_entry = &sc->mapping_table[map_idx];
1094                                 _mapping_clear_map_entry(mt_entry);
1095                                 if (map_idx == (enc_entry->start_index +
1096                                     enc_entry->num_slots - 1))
1097                                         _mapping_clear_enc_entry(et_entry);
1098                         }
1099                 }
1100
1101                 /*
1102                  * During the search for space for this enclosure, some entries
1103                  * in the mapping table may have been unreserved. Go back and
1104                  * change all of these to reserved again. Only the enclosures
1105                  * with the removal_flag set should be left as unreserved. The
1106                  * skip_search flag needs to be cleared as well so that the
1107                  * enclosure's space will be looked at the next time space is
1108                  * needed.
1109                  */ 
1110                 enc_entry = sc->enclosure_table;
1111                 for (enc_idx = 0; enc_idx < sc->num_enc_table_entries;
1112                     enc_idx++, enc_entry++) {
1113                         if (!enc_entry->removal_flag) {
1114                                 mpr_dprint(sc, MPR_MAPPING, "%s: Reset the "
1115                                     "reserved flag for all of the map entries "
1116                                     "for enclosure %d.\n", __func__, enc_idx);
1117                                 mt_entry = &sc->mapping_table[enc_entry->
1118                                     start_index];
1119                                 for (map_idx = enc_entry->start_index; map_idx <
1120                                     (enc_entry->start_index +
1121                                     enc_entry->num_slots); map_idx++,
1122                                     mt_entry++)
1123                                         mt_entry->device_info |=
1124                                             MPR_DEV_RESERVED;
1125                                 et_entry->skip_search = 0;
1126                         }
1127                 }
1128                 done_flag = 1;
1129         }
1130         return start_idx;
1131 }
1132
1133 /**
1134  * _mapping_get_dev_info -get information about newly added devices
1135  * @sc: per adapter object
1136  * @topo_change: Topology change event entry
1137  *
1138  * Search through the topology change event list and issues sas device pg0
1139  * requests for the newly added device and reserved entries in tables
1140  *
1141  * Returns nothing
1142  */
1143 static void
1144 _mapping_get_dev_info(struct mpr_softc *sc,
1145     struct _map_topology_change *topo_change)
1146 {
1147         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1148         Mpi2ConfigReply_t mpi_reply;
1149         Mpi2SasDevicePage0_t sas_device_pg0;
1150         u8 entry, enc_idx, phy_idx;
1151         u32 map_idx, index, device_info;
1152         struct _map_phy_change *phy_change, *tmp_phy_change;
1153         uint64_t sas_address;
1154         struct enc_mapping_table *et_entry;
1155         struct dev_mapping_table *mt_entry;
1156         u8 add_code = MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED;
1157         int rc = 1;
1158
1159         for (entry = 0; entry < topo_change->num_entries; entry++) {
1160                 phy_change = &topo_change->phy_details[entry];
1161                 if (phy_change->is_processed || !phy_change->dev_handle ||
1162                     phy_change->reason != MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED)
1163                         continue;
1164
1165                 if (mpr_config_get_sas_device_pg0(sc, &mpi_reply,
1166                     &sas_device_pg0, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
1167                     phy_change->dev_handle)) {
1168                         phy_change->is_processed = 1;
1169                         continue;
1170                 }
1171
1172                 /*
1173                  * Always get SATA Identify information because this is used
1174                  * to determine if Start/Stop Unit should be sent to the drive
1175                  * when the system is shutdown.
1176                  */
1177                 device_info = le32toh(sas_device_pg0.DeviceInfo);
1178                 sas_address = le32toh(sas_device_pg0.SASAddress.High);
1179                 sas_address = (sas_address << 32) |
1180                     le32toh(sas_device_pg0.SASAddress.Low);
1181                 if ((device_info & MPI2_SAS_DEVICE_INFO_END_DEVICE) &&
1182                     (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE)) {
1183                         rc = mprsas_get_sas_address_for_sata_disk(sc,
1184                             &sas_address, phy_change->dev_handle, device_info,
1185                             &phy_change->is_SATA_SSD);
1186                         if (rc) {
1187                                 mpr_dprint(sc, MPR_ERROR, "%s: failed to get "
1188                                     "disk type (SSD or HDD) and SAS Address "
1189                                     "for SATA device with handle 0x%04x\n",
1190                                     __func__, phy_change->dev_handle);
1191                         }
1192                 }
1193
1194                 phy_change->physical_id = sas_address;
1195                 phy_change->slot = le16toh(sas_device_pg0.Slot);
1196                 phy_change->device_info = device_info;
1197
1198                 /*
1199                  * When using Enc/Slot mapping, if this device is an enclosure
1200                  * make sure that all of its slots can fit into the mapping
1201                  * table.
1202                  */
1203                 if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
1204                     MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
1205                         /*
1206                          * The enclosure should already be in the enclosure
1207                          * table due to the Enclosure Add event. If not, just
1208                          * continue, nothing can be done.
1209                          */
1210                         enc_idx = _mapping_get_enc_idx_from_handle(sc,
1211                             topo_change->enc_handle);
1212                         if (enc_idx == MPR_ENCTABLE_BAD_IDX) {
1213                                 phy_change->is_processed = 1;
1214                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
1215                                     "failed to add the device with handle "
1216                                     "0x%04x because the enclosure is not in "
1217                                     "the mapping table\n", __func__,
1218                                     phy_change->dev_handle);
1219                                 continue;
1220                         }
1221                         if (!((phy_change->device_info &
1222                             MPI2_SAS_DEVICE_INFO_END_DEVICE) &&
1223                             (phy_change->device_info &
1224                             (MPI2_SAS_DEVICE_INFO_SSP_TARGET |
1225                             MPI2_SAS_DEVICE_INFO_STP_TARGET |
1226                             MPI2_SAS_DEVICE_INFO_SATA_DEVICE)))) {
1227                                 phy_change->is_processed = 1;
1228                                 continue;
1229                         }
1230                         et_entry = &sc->enclosure_table[enc_idx];
1231
1232                         /*
1233                          * If the enclosure already has a start_index, it's been
1234                          * mapped, so go to the next Topo change.
1235                          */
1236                         if (et_entry->start_index != MPR_MAPTABLE_BAD_IDX)
1237                                 continue;
1238
1239                         /*
1240                          * If the Expander Handle is 0, the devices are direct
1241                          * attached. In that case, the start_index must be just 
1242                          * after the reserved entries. Otherwise, find space in
1243                          * the mapping table for the enclosure's devices.
1244                          */ 
1245                         if (!topo_change->exp_handle) {
1246                                 map_idx = sc->num_rsvd_entries;
1247                                 et_entry->start_index = map_idx;
1248                         } else {
1249                                 map_idx = _mapping_find_enc_map_space(sc,
1250                                     et_entry);
1251                                 et_entry->start_index = map_idx;
1252
1253                                 /*
1254                                  * If space cannot be found to hold all of the
1255                                  * enclosure's devices in the mapping table,
1256                                  * there's no need to continue checking the
1257                                  * other devices in this event. Set all of the
1258                                  * phy_details for this event (if the change is
1259                                  * for an add) as already processed because none
1260                                  * of these devices can be added to the mapping
1261                                  * table.
1262                                  */
1263                                 if (et_entry->start_index ==
1264                                     MPR_MAPTABLE_BAD_IDX) {
1265                                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING,
1266                                             "%s: failed to add the enclosure "
1267                                             "with ID 0x%016jx because there is "
1268                                             "no free space available in the "
1269                                             "mapping table for all of the "
1270                                             "enclosure's devices.\n", __func__,
1271                                             (uintmax_t)et_entry->enclosure_id);
1272                                         phy_change->is_processed = 1;
1273                                         for (phy_idx = 0; phy_idx <
1274                                             topo_change->num_entries;
1275                                             phy_idx++) {
1276                                                 tmp_phy_change =
1277                                                     &topo_change->phy_details
1278                                                     [phy_idx];
1279                                                 if (tmp_phy_change->reason ==
1280                                                     add_code)
1281                                                         tmp_phy_change->
1282                                                             is_processed = 1;
1283                                         }
1284                                         break;
1285                                 }
1286                         }
1287
1288                         /*
1289                          * Found space in the mapping table for this enclosure.
1290                          * Initialize each mapping table entry for the
1291                          * enclosure.
1292                          */
1293                         mpr_dprint(sc, MPR_MAPPING, "%s: Initialize %d map "
1294                             "entries for the enclosure, starting at map index "
1295                             " %d.\n", __func__, et_entry->num_slots, map_idx);
1296                         mt_entry = &sc->mapping_table[map_idx];
1297                         for (index = map_idx; index < (et_entry->num_slots
1298                             + map_idx); index++, mt_entry++) {
1299                                 mt_entry->device_info = MPR_DEV_RESERVED;
1300                                 mt_entry->physical_id = et_entry->enclosure_id;
1301                                 mt_entry->phy_bits = et_entry->phy_bits;
1302                                 mt_entry->missing_count = 0;
1303                         }
1304                 }
1305         }
1306 }
1307
1308 /**
1309  * _mapping_get_pcie_dev_info -get information about newly added PCIe devices
1310  * @sc: per adapter object
1311  * @topo_change: Topology change event entry
1312  *
1313  * Searches through the PCIe topology change event list and issues PCIe device
1314  * pg0 requests for the newly added PCIe device. If the device is in an
1315  * enclosure, search for available space in the enclosure mapping table for the
1316  * device and reserve that space.
1317  *
1318  * Returns nothing
1319  */
1320 static void
1321 _mapping_get_pcie_dev_info(struct mpr_softc *sc,
1322     struct _map_pcie_topology_change *topo_change)
1323 {
1324         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1325         Mpi2ConfigReply_t mpi_reply;
1326         Mpi26PCIeDevicePage0_t pcie_device_pg0;
1327         u8 entry, enc_idx, port_idx;
1328         u32 map_idx, index;
1329         struct _map_port_change *port_change, *tmp_port_change;
1330         uint64_t pcie_wwid;
1331         struct enc_mapping_table *et_entry;
1332         struct dev_mapping_table *mt_entry;
1333         u8 add_code = MPI26_EVENT_PCIE_TOPO_PS_DEV_ADDED;
1334
1335         for (entry = 0; entry < topo_change->num_entries; entry++) {
1336                 port_change = &topo_change->port_details[entry];
1337                 if (port_change->is_processed || !port_change->dev_handle ||
1338                     port_change->reason != MPI26_EVENT_PCIE_TOPO_PS_DEV_ADDED)
1339                         continue;
1340                 if (mpr_config_get_pcie_device_pg0(sc, &mpi_reply,
1341                     &pcie_device_pg0, MPI26_PCIE_DEVICE_PGAD_FORM_HANDLE,
1342                     port_change->dev_handle)) {
1343                         port_change->is_processed = 1;
1344                         continue;
1345                 }
1346
1347                 pcie_wwid = pcie_device_pg0.WWID.High;
1348                 pcie_wwid = (pcie_wwid << 32) | pcie_device_pg0.WWID.Low;
1349                 port_change->physical_id = pcie_wwid;
1350                 port_change->slot = le16toh(pcie_device_pg0.Slot);
1351                 port_change->device_info = le32toh(pcie_device_pg0.DeviceInfo);
1352
1353                 /*
1354                  * When using Enc/Slot mapping, if this device is an enclosure
1355                  * make sure that all of its slots can fit into the mapping
1356                  * table.
1357                  */
1358                 if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
1359                     MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
1360                         /*
1361                          * The enclosure should already be in the enclosure
1362                          * table due to the Enclosure Add event. If not, just
1363                          * continue, nothing can be done.
1364                          */
1365                         enc_idx = _mapping_get_enc_idx_from_handle(sc,
1366                             topo_change->enc_handle);
1367                         if (enc_idx == MPR_ENCTABLE_BAD_IDX) {
1368                                 port_change->is_processed = 1;
1369                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
1370                                     "failed to add the device with handle "
1371                                     "0x%04x because the enclosure is not in "
1372                                     "the mapping table\n", __func__,
1373                                     port_change->dev_handle);
1374                                 continue;
1375                         }
1376                         if (!(port_change->device_info &
1377                             MPI26_PCIE_DEVINFO_NVME)) {
1378                                 port_change->is_processed = 1;
1379                                 continue;
1380                         }
1381                         et_entry = &sc->enclosure_table[enc_idx];
1382
1383                         /*
1384                          * If the enclosure already has a start_index, it's been
1385                          * mapped, so go to the next Topo change.
1386                          */
1387                         if (et_entry->start_index != MPR_MAPTABLE_BAD_IDX)
1388                                 continue;
1389
1390                         /*
1391                          * If the Switch Handle is 0, the devices are direct
1392                          * attached. In that case, the start_index must be just 
1393                          * after the reserved entries. Otherwise, find space in
1394                          * the mapping table for the enclosure's devices.
1395                          */ 
1396                         if (!topo_change->switch_dev_handle) {
1397                                 map_idx = sc->num_rsvd_entries;
1398                                 et_entry->start_index = map_idx;
1399                         } else {
1400                                 map_idx = _mapping_find_enc_map_space(sc,
1401                                     et_entry);
1402                                 et_entry->start_index = map_idx;
1403
1404                                 /*
1405                                  * If space cannot be found to hold all of the
1406                                  * enclosure's devices in the mapping table,
1407                                  * there's no need to continue checking the
1408                                  * other devices in this event. Set all of the
1409                                  * port_details for this event (if the change is
1410                                  * for an add) as already processed because none
1411                                  * of these devices can be added to the mapping
1412                                  * table.
1413                                  */
1414                                 if (et_entry->start_index ==
1415                                     MPR_MAPTABLE_BAD_IDX) {
1416                                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING,
1417                                             "%s: failed to add the enclosure "
1418                                             "with ID 0x%016jx because there is "
1419                                             "no free space available in the "
1420                                             "mapping table for all of the "
1421                                             "enclosure's devices.\n", __func__,
1422                                             (uintmax_t)et_entry->enclosure_id);
1423                                         port_change->is_processed = 1;
1424                                         for (port_idx = 0; port_idx <
1425                                             topo_change->num_entries;
1426                                             port_idx++) {
1427                                                 tmp_port_change =
1428                                                     &topo_change->port_details
1429                                                     [port_idx];
1430                                                 if (tmp_port_change->reason ==
1431                                                     add_code)
1432                                                         tmp_port_change->
1433                                                             is_processed = 1;
1434                                         }
1435                                         break;
1436                                 }
1437                         }
1438
1439                         /*
1440                          * Found space in the mapping table for this enclosure.
1441                          * Initialize each mapping table entry for the
1442                          * enclosure.
1443                          */
1444                         mpr_dprint(sc, MPR_MAPPING, "%s: Initialize %d map "
1445                             "entries for the enclosure, starting at map index "
1446                             " %d.\n", __func__, et_entry->num_slots, map_idx);
1447                         mt_entry = &sc->mapping_table[map_idx];
1448                         for (index = map_idx; index < (et_entry->num_slots
1449                             + map_idx); index++, mt_entry++) {
1450                                 mt_entry->device_info = MPR_DEV_RESERVED;
1451                                 mt_entry->physical_id = et_entry->enclosure_id;
1452                                 mt_entry->phy_bits = et_entry->phy_bits;
1453                                 mt_entry->missing_count = 0;
1454                         }
1455                 }
1456         }
1457 }
1458
1459 /**
1460  * _mapping_set_mid_to_eid -set map table data from enclosure table
1461  * @sc: per adapter object
1462  * @et_entry: enclosure entry
1463  *
1464  * Returns nothing
1465  */
1466 static inline void
1467 _mapping_set_mid_to_eid(struct mpr_softc *sc,
1468     struct enc_mapping_table *et_entry)
1469 {
1470         struct dev_mapping_table *mt_entry;
1471         u16 slots = et_entry->num_slots, map_idx;
1472         u32 start_idx = et_entry->start_index;
1473
1474         if (start_idx != MPR_MAPTABLE_BAD_IDX) {
1475                 mt_entry = &sc->mapping_table[start_idx];
1476                 for (map_idx = 0; map_idx < slots; map_idx++, mt_entry++)
1477                         mt_entry->physical_id = et_entry->enclosure_id;
1478         }
1479 }
1480
1481 /**
1482  * _mapping_clear_removed_entries - mark the entries to be cleared
1483  * @sc: per adapter object
1484  *
1485  * Search through the removal table and mark the entries which needs to be
1486  * flushed to DPM and also updates the map table and enclosure table by
1487  * clearing the corresponding entries.
1488  *
1489  * Returns nothing
1490  */
1491 static void
1492 _mapping_clear_removed_entries(struct mpr_softc *sc)
1493 {
1494         u32 remove_idx;
1495         struct map_removal_table *remove_entry;
1496         Mpi2DriverMap0Entry_t *dpm_entry;
1497         u8 done_flag = 0, num_entries, m, i;
1498         struct enc_mapping_table *et_entry, *from, *to;
1499         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1500
1501         if (sc->is_dpm_enable) {
1502                 remove_entry = sc->removal_table;
1503                 for (remove_idx = 0; remove_idx < sc->max_devices;
1504                     remove_idx++, remove_entry++) {
1505                         if (remove_entry->dpm_entry_num != MPR_DPM_BAD_IDX) {
1506                                 dpm_entry = (Mpi2DriverMap0Entry_t *)
1507                                     ((u8 *) sc->dpm_pg0 +
1508                                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
1509                                 dpm_entry += remove_entry->dpm_entry_num;
1510                                 dpm_entry->PhysicalIdentifier.Low = 0;
1511                                 dpm_entry->PhysicalIdentifier.High = 0;
1512                                 dpm_entry->DeviceIndex = 0;
1513                                 dpm_entry->MappingInformation = 0;
1514                                 dpm_entry->PhysicalBitsMapping = 0;
1515                                 sc->dpm_flush_entry[remove_entry->
1516                                     dpm_entry_num] = 1;
1517                                 sc->dpm_entry_used[remove_entry->dpm_entry_num]
1518                                     = 0;
1519                                 remove_entry->dpm_entry_num = MPR_DPM_BAD_IDX;
1520                         }
1521                 }
1522         }
1523
1524         /*
1525          * When using Enc/Slot mapping, if a new enclosure was added and old
1526          * enclosure space was needed, the enclosure table may now have gaps
1527          * that need to be closed. All enclosure mappings need to be contiguous
1528          * so that space can be reused correctly if available.
1529          */
1530         if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
1531             MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
1532                 num_entries = sc->num_enc_table_entries;
1533                 while (!done_flag) {
1534                         done_flag = 1;
1535                         et_entry = sc->enclosure_table;
1536                         for (i = 0; i < num_entries; i++, et_entry++) {
1537                                 if (!et_entry->enc_handle && et_entry->
1538                                     init_complete) {
1539                                         done_flag = 0;
1540                                         if (i != (num_entries - 1)) {
1541                                                 from = &sc->enclosure_table
1542                                                     [i+1];
1543                                                 to = &sc->enclosure_table[i];
1544                                                 for (m = i; m < (num_entries -
1545                                                     1); m++, from++, to++) {
1546                                                         _mapping_set_mid_to_eid
1547                                                             (sc, to);
1548                                                         *to = *from;
1549                                                 }
1550                                                 _mapping_clear_enc_entry(to);
1551                                                 sc->num_enc_table_entries--;
1552                                                 num_entries =
1553                                                     sc->num_enc_table_entries;
1554                                         } else {
1555                                                 _mapping_clear_enc_entry
1556                                                     (et_entry);
1557                                                 sc->num_enc_table_entries--;
1558                                                 num_entries =
1559                                                     sc->num_enc_table_entries;
1560                                         }
1561                                 }
1562                         }
1563                 }
1564         }
1565 }
1566
1567 /**
1568  * _mapping_add_new_device -Add the new device into mapping table
1569  * @sc: per adapter object
1570  * @topo_change: Topology change event entry
1571  *
1572  * Search through the topology change event list and update map table,
1573  * enclosure table and DPM pages for the newly added devices.
1574  *
1575  * Returns nothing
1576  */
1577 static void
1578 _mapping_add_new_device(struct mpr_softc *sc,
1579     struct _map_topology_change *topo_change)
1580 {
1581         u8 enc_idx, missing_cnt, is_removed = 0;
1582         u16 dpm_idx;
1583         u32 search_idx, map_idx;
1584         u32 entry;
1585         struct dev_mapping_table *mt_entry;
1586         struct enc_mapping_table *et_entry;
1587         struct _map_phy_change *phy_change;
1588         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1589         Mpi2DriverMap0Entry_t *dpm_entry;
1590         uint64_t temp64_var;
1591         u8 map_shift = MPI2_DRVMAP0_MAPINFO_SLOT_SHIFT;
1592         u8 hdr_sz = sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER);
1593         u16 max_num_phy_ids = le16toh(sc->ioc_pg8.MaxNumPhysicalMappedIDs);
1594
1595         for (entry = 0; entry < topo_change->num_entries; entry++) {
1596                 phy_change = &topo_change->phy_details[entry];
1597                 if (phy_change->is_processed)
1598                         continue;
1599                 if (phy_change->reason != MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED ||
1600                     !phy_change->dev_handle) {
1601                         phy_change->is_processed = 1;
1602                         continue;
1603                 }
1604                 if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
1605                     MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
1606                         enc_idx = _mapping_get_enc_idx_from_handle
1607                             (sc, topo_change->enc_handle);
1608                         if (enc_idx == MPR_ENCTABLE_BAD_IDX) {
1609                                 phy_change->is_processed = 1;
1610                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
1611                                     "failed to add the device with handle "
1612                                     "0x%04x because the enclosure is not in "
1613                                     "the mapping table\n", __func__,
1614                                     phy_change->dev_handle);
1615                                 continue;
1616                         }
1617
1618                         /*
1619                          * If the enclosure's start_index is BAD here, it means
1620                          * that there is no room in the mapping table to cover
1621                          * all of the devices that could be in the enclosure.
1622                          * There's no reason to process any of the devices for
1623                          * this enclosure since they can't be mapped.
1624                          */
1625                         et_entry = &sc->enclosure_table[enc_idx];
1626                         if (et_entry->start_index == MPR_MAPTABLE_BAD_IDX) {
1627                                 phy_change->is_processed = 1;
1628                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
1629                                     "failed to add the device with handle "
1630                                     "0x%04x because there is no free space "
1631                                     "available in the mapping table\n",
1632                                     __func__, phy_change->dev_handle);
1633                                 continue;
1634                         }
1635
1636                         /*
1637                          * Add this device to the mapping table at the correct
1638                          * offset where space was found to map the enclosure.
1639                          * Then setup the DPM entry information if being used.
1640                          */
1641                         map_idx = et_entry->start_index + phy_change->slot -
1642                             et_entry->start_slot;
1643                         mt_entry = &sc->mapping_table[map_idx];
1644                         mt_entry->physical_id = phy_change->physical_id;
1645                         mt_entry->id = map_idx;
1646                         mt_entry->dev_handle = phy_change->dev_handle;
1647                         mt_entry->missing_count = 0;
1648                         mt_entry->dpm_entry_num = et_entry->dpm_entry_num;
1649                         mt_entry->device_info = phy_change->device_info |
1650                             (MPR_DEV_RESERVED | MPR_MAP_IN_USE);
1651                         if (sc->is_dpm_enable) {
1652                                 dpm_idx = et_entry->dpm_entry_num;
1653                                 if (dpm_idx == MPR_DPM_BAD_IDX)
1654                                         dpm_idx = _mapping_get_dpm_idx_from_id
1655                                             (sc, et_entry->enclosure_id,
1656                                              et_entry->phy_bits);
1657                                 if (dpm_idx == MPR_DPM_BAD_IDX) {
1658                                         dpm_idx = _mapping_get_free_dpm_idx(sc);
1659                                         if (dpm_idx != MPR_DPM_BAD_IDX) {
1660                                                 dpm_entry =
1661                                                     (Mpi2DriverMap0Entry_t *)
1662                                                     ((u8 *) sc->dpm_pg0 +
1663                                                      hdr_sz);
1664                                                 dpm_entry += dpm_idx;
1665                                                 dpm_entry->
1666                                                     PhysicalIdentifier.Low =
1667                                                     (0xFFFFFFFF &
1668                                                     et_entry->enclosure_id);
1669                                                 dpm_entry->
1670                                                     PhysicalIdentifier.High =
1671                                                     (et_entry->enclosure_id
1672                                                      >> 32);
1673                                                 dpm_entry->DeviceIndex =
1674                                                     (U16)et_entry->start_index;
1675                                                 dpm_entry->MappingInformation =
1676                                                     et_entry->num_slots;
1677                                                 dpm_entry->MappingInformation
1678                                                     <<= map_shift;
1679                                                 dpm_entry->PhysicalBitsMapping
1680                                                     = et_entry->phy_bits;
1681                                                 et_entry->dpm_entry_num =
1682                                                     dpm_idx;
1683                                                 sc->dpm_entry_used[dpm_idx] = 1;
1684                                                 sc->dpm_flush_entry[dpm_idx] =
1685                                                     1;
1686                                                 phy_change->is_processed = 1;
1687                                         } else {
1688                                                 phy_change->is_processed = 1;
1689                                                 mpr_dprint(sc, MPR_ERROR |
1690                                                     MPR_MAPPING, "%s: failed "
1691                                                     "to add the device with "
1692                                                     "handle 0x%04x to "
1693                                                     "persistent table because "
1694                                                     "there is no free space "
1695                                                     "available\n", __func__,
1696                                                     phy_change->dev_handle);
1697                                         }
1698                                 } else {
1699                                         et_entry->dpm_entry_num = dpm_idx;
1700                                         mt_entry->dpm_entry_num = dpm_idx;
1701                                 }
1702                         }
1703                         et_entry->init_complete = 1;
1704                 } else if ((ioc_pg8_flags &
1705                     MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
1706                     MPI2_IOCPAGE8_FLAGS_DEVICE_PERSISTENCE_MAPPING) {
1707
1708                         /*
1709                          * Get the mapping table index for this device. If it's
1710                          * not in the mapping table yet, find a free entry if
1711                          * one is available. If there are no free entries, look
1712                          * for the entry that has the highest missing count. If
1713                          * none of that works to find an entry in the mapping
1714                          * table, there is a problem. Log a message and just
1715                          * continue on.
1716                          */
1717                         map_idx = _mapping_get_mt_idx_from_id
1718                             (sc, phy_change->physical_id);
1719                         if (map_idx == MPR_MAPTABLE_BAD_IDX) {
1720                                 search_idx = sc->num_rsvd_entries;
1721                                 if (topo_change->exp_handle)
1722                                         search_idx += max_num_phy_ids;
1723                                 map_idx = _mapping_get_free_mt_idx(sc,
1724                                     search_idx);
1725                         }
1726
1727                         /*
1728                          * If an entry will be used that has a missing device,
1729                          * clear its entry from  the DPM in the controller.
1730                          */
1731                         if (map_idx == MPR_MAPTABLE_BAD_IDX) {
1732                                 map_idx = _mapping_get_high_missing_mt_idx(sc);
1733                                 if (map_idx != MPR_MAPTABLE_BAD_IDX) {
1734                                         mt_entry = &sc->mapping_table[map_idx];
1735                                         _mapping_add_to_removal_table(sc,
1736                                             mt_entry->dpm_entry_num);
1737                                         is_removed = 1;
1738                                         mt_entry->init_complete = 0;
1739                                 }
1740                         }
1741                         if (map_idx != MPR_MAPTABLE_BAD_IDX) {
1742                                 mt_entry = &sc->mapping_table[map_idx];
1743                                 mt_entry->physical_id = phy_change->physical_id;
1744                                 mt_entry->id = map_idx;
1745                                 mt_entry->dev_handle = phy_change->dev_handle;
1746                                 mt_entry->missing_count = 0;
1747                                 mt_entry->device_info = phy_change->device_info
1748                                     | (MPR_DEV_RESERVED | MPR_MAP_IN_USE);
1749                         } else {
1750                                 phy_change->is_processed = 1;
1751                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
1752                                     "failed to add the device with handle "
1753                                     "0x%04x because there is no free space "
1754                                     "available in the mapping table\n",
1755                                     __func__, phy_change->dev_handle);
1756                                 continue;
1757                         }
1758                         if (sc->is_dpm_enable) {
1759                                 if (mt_entry->dpm_entry_num !=
1760                                     MPR_DPM_BAD_IDX) {
1761                                         dpm_idx = mt_entry->dpm_entry_num;
1762                                         dpm_entry = (Mpi2DriverMap0Entry_t *)
1763                                             ((u8 *)sc->dpm_pg0 + hdr_sz);
1764                                         dpm_entry += dpm_idx;
1765                                         missing_cnt = dpm_entry->
1766                                             MappingInformation &
1767                                             MPI2_DRVMAP0_MAPINFO_MISSING_MASK;
1768                                         temp64_var = dpm_entry->
1769                                             PhysicalIdentifier.High;
1770                                         temp64_var = (temp64_var << 32) |
1771                                            dpm_entry->PhysicalIdentifier.Low;
1772
1773                                         /*
1774                                          * If the Mapping Table's info is not
1775                                          * the same as the DPM entry, clear the
1776                                          * init_complete flag so that it's
1777                                          * updated.
1778                                          */
1779                                         if ((mt_entry->physical_id ==
1780                                             temp64_var) && !missing_cnt)
1781                                                 mt_entry->init_complete = 1;
1782                                         else
1783                                                 mt_entry->init_complete = 0;
1784                                 } else {
1785                                         dpm_idx = _mapping_get_free_dpm_idx(sc);
1786                                         mt_entry->init_complete = 0;
1787                                 }
1788                                 if (dpm_idx != MPR_DPM_BAD_IDX &&
1789                                     !mt_entry->init_complete) {
1790                                         mt_entry->dpm_entry_num = dpm_idx;
1791                                         dpm_entry = (Mpi2DriverMap0Entry_t *)
1792                                             ((u8 *)sc->dpm_pg0 + hdr_sz);
1793                                         dpm_entry += dpm_idx;
1794                                         dpm_entry->PhysicalIdentifier.Low =
1795                                             (0xFFFFFFFF &
1796                                             mt_entry->physical_id);
1797                                         dpm_entry->PhysicalIdentifier.High =
1798                                             (mt_entry->physical_id >> 32);
1799                                         dpm_entry->DeviceIndex = (U16) map_idx;
1800                                         dpm_entry->MappingInformation = 0;
1801                                         dpm_entry->PhysicalBitsMapping = 0;
1802                                         sc->dpm_entry_used[dpm_idx] = 1;
1803                                         sc->dpm_flush_entry[dpm_idx] = 1;
1804                                         phy_change->is_processed = 1;
1805                                 } else if (dpm_idx == MPR_DPM_BAD_IDX) {
1806                                         phy_change->is_processed = 1;
1807                                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING,
1808                                             "%s: failed to add the device with "
1809                                             "handle 0x%04x to persistent table "
1810                                             "because there is no free space "
1811                                             "available\n", __func__,
1812                                             phy_change->dev_handle);
1813                                 }
1814                         }
1815                         mt_entry->init_complete = 1;
1816                 }
1817
1818                 phy_change->is_processed = 1;
1819         }
1820         if (is_removed)
1821                 _mapping_clear_removed_entries(sc);
1822 }
1823
1824 /**
1825  * _mapping_add_new_pcie_device -Add the new PCIe device into mapping table
1826  * @sc: per adapter object
1827  * @topo_change: Topology change event entry
1828  *
1829  * Search through the PCIe topology change event list and update map table,
1830  * enclosure table and DPM pages for the newly added devices.
1831  *
1832  * Returns nothing
1833  */
1834 static void
1835 _mapping_add_new_pcie_device(struct mpr_softc *sc,
1836     struct _map_pcie_topology_change *topo_change)
1837 {
1838         u8 enc_idx, missing_cnt, is_removed = 0;
1839         u16 dpm_idx;
1840         u32 search_idx, map_idx;
1841         u32 entry;
1842         struct dev_mapping_table *mt_entry;
1843         struct enc_mapping_table *et_entry;
1844         struct _map_port_change *port_change;
1845         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1846         Mpi2DriverMap0Entry_t *dpm_entry;
1847         uint64_t temp64_var;
1848         u8 map_shift = MPI2_DRVMAP0_MAPINFO_SLOT_SHIFT;
1849         u8 hdr_sz = sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER);
1850         u16 max_num_phy_ids = le16toh(sc->ioc_pg8.MaxNumPhysicalMappedIDs);
1851
1852         for (entry = 0; entry < topo_change->num_entries; entry++) {
1853                 port_change = &topo_change->port_details[entry];
1854                 if (port_change->is_processed)
1855                         continue;
1856                 if (port_change->reason != MPI26_EVENT_PCIE_TOPO_PS_DEV_ADDED ||
1857                     !port_change->dev_handle) {
1858                         port_change->is_processed = 1;
1859                         continue;
1860                 }
1861                 if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
1862                     MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
1863                         enc_idx = _mapping_get_enc_idx_from_handle
1864                             (sc, topo_change->enc_handle);
1865                         if (enc_idx == MPR_ENCTABLE_BAD_IDX) {
1866                                 port_change->is_processed = 1;
1867                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
1868                                     "failed to add the device with handle "
1869                                     "0x%04x because the enclosure is not in "
1870                                     "the mapping table\n", __func__,
1871                                     port_change->dev_handle);
1872                                 continue;
1873                         }
1874
1875                         /*
1876                          * If the enclosure's start_index is BAD here, it means
1877                          * that there is no room in the mapping table to cover
1878                          * all of the devices that could be in the enclosure.
1879                          * There's no reason to process any of the devices for
1880                          * this enclosure since they can't be mapped.
1881                          */
1882                         et_entry = &sc->enclosure_table[enc_idx];
1883                         if (et_entry->start_index == MPR_MAPTABLE_BAD_IDX) {
1884                                 port_change->is_processed = 1;
1885                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
1886                                     "failed to add the device with handle "
1887                                     "0x%04x because there is no free space "
1888                                     "available in the mapping table\n",
1889                                     __func__, port_change->dev_handle);
1890                                 continue;
1891                         }
1892
1893                         /*
1894                          * Add this device to the mapping table at the correct
1895                          * offset where space was found to map the enclosure.
1896                          * Then setup the DPM entry information if being used.
1897                          */
1898                         map_idx = et_entry->start_index + port_change->slot -
1899                             et_entry->start_slot;
1900                         mt_entry = &sc->mapping_table[map_idx];
1901                         mt_entry->physical_id = port_change->physical_id;
1902                         mt_entry->id = map_idx;
1903                         mt_entry->dev_handle = port_change->dev_handle;
1904                         mt_entry->missing_count = 0;
1905                         mt_entry->dpm_entry_num = et_entry->dpm_entry_num;
1906                         mt_entry->device_info = port_change->device_info |
1907                             (MPR_DEV_RESERVED | MPR_MAP_IN_USE);
1908                         if (sc->is_dpm_enable) {
1909                                 dpm_idx = et_entry->dpm_entry_num;
1910                                 if (dpm_idx == MPR_DPM_BAD_IDX)
1911                                         dpm_idx = _mapping_get_dpm_idx_from_id
1912                                             (sc, et_entry->enclosure_id,
1913                                              et_entry->phy_bits);
1914                                 if (dpm_idx == MPR_DPM_BAD_IDX) {
1915                                         dpm_idx = _mapping_get_free_dpm_idx(sc);
1916                                         if (dpm_idx != MPR_DPM_BAD_IDX) {
1917                                                 dpm_entry =
1918                                                     (Mpi2DriverMap0Entry_t *)
1919                                                     ((u8 *) sc->dpm_pg0 +
1920                                                      hdr_sz);
1921                                                 dpm_entry += dpm_idx;
1922                                                 dpm_entry->
1923                                                     PhysicalIdentifier.Low =
1924                                                     (0xFFFFFFFF &
1925                                                     et_entry->enclosure_id);
1926                                                 dpm_entry->
1927                                                     PhysicalIdentifier.High =
1928                                                     (et_entry->enclosure_id
1929                                                      >> 32);
1930                                                 dpm_entry->DeviceIndex =
1931                                                     (U16)et_entry->start_index;
1932                                                 dpm_entry->MappingInformation =
1933                                                     et_entry->num_slots;
1934                                                 dpm_entry->MappingInformation
1935                                                     <<= map_shift;
1936                                                 dpm_entry->PhysicalBitsMapping
1937                                                     = et_entry->phy_bits;
1938                                                 et_entry->dpm_entry_num =
1939                                                     dpm_idx;
1940                                                 sc->dpm_entry_used[dpm_idx] = 1;
1941                                                 sc->dpm_flush_entry[dpm_idx] =
1942                                                     1;
1943                                                 port_change->is_processed = 1;
1944                                         } else {
1945                                                 port_change->is_processed = 1;
1946                                                 mpr_dprint(sc, MPR_ERROR |
1947                                                     MPR_MAPPING, "%s: failed "
1948                                                     "to add the device with "
1949                                                     "handle 0x%04x to "
1950                                                     "persistent table because "
1951                                                     "there is no free space "
1952                                                     "available\n", __func__,
1953                                                     port_change->dev_handle);
1954                                         }
1955                                 } else {
1956                                         et_entry->dpm_entry_num = dpm_idx;
1957                                         mt_entry->dpm_entry_num = dpm_idx;
1958                                 }
1959                         }
1960                         et_entry->init_complete = 1;
1961                 } else if ((ioc_pg8_flags &
1962                     MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
1963                     MPI2_IOCPAGE8_FLAGS_DEVICE_PERSISTENCE_MAPPING) {
1964
1965                         /*
1966                          * Get the mapping table index for this device. If it's
1967                          * not in the mapping table yet, find a free entry if
1968                          * one is available. If there are no free entries, look
1969                          * for the entry that has the highest missing count. If
1970                          * none of that works to find an entry in the mapping
1971                          * table, there is a problem. Log a message and just
1972                          * continue on.
1973                          */
1974                         map_idx = _mapping_get_mt_idx_from_id
1975                             (sc, port_change->physical_id);
1976                         if (map_idx == MPR_MAPTABLE_BAD_IDX) {
1977                                 search_idx = sc->num_rsvd_entries;
1978                                 if (topo_change->switch_dev_handle)
1979                                         search_idx += max_num_phy_ids;
1980                                 map_idx = _mapping_get_free_mt_idx(sc,
1981                                     search_idx);
1982                         }
1983
1984                         /*
1985                          * If an entry will be used that has a missing device,
1986                          * clear its entry from  the DPM in the controller.
1987                          */
1988                         if (map_idx == MPR_MAPTABLE_BAD_IDX) {
1989                                 map_idx = _mapping_get_high_missing_mt_idx(sc);
1990                                 if (map_idx != MPR_MAPTABLE_BAD_IDX) {
1991                                         mt_entry = &sc->mapping_table[map_idx];
1992                                         _mapping_add_to_removal_table(sc,
1993                                             mt_entry->dpm_entry_num);
1994                                         is_removed = 1;
1995                                         mt_entry->init_complete = 0;
1996                                 }
1997                         }
1998                         if (map_idx != MPR_MAPTABLE_BAD_IDX) {
1999                                 mt_entry = &sc->mapping_table[map_idx];
2000                                 mt_entry->physical_id =
2001                                     port_change->physical_id;
2002                                 mt_entry->id = map_idx;
2003                                 mt_entry->dev_handle = port_change->dev_handle;
2004                                 mt_entry->missing_count = 0;
2005                                 mt_entry->device_info =
2006                                     port_change->device_info |
2007                                     (MPR_DEV_RESERVED | MPR_MAP_IN_USE);
2008                         } else {
2009                                 port_change->is_processed = 1;
2010                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
2011                                     "failed to add the device with handle "
2012                                     "0x%04x because there is no free space "
2013                                     "available in the mapping table\n",
2014                                     __func__, port_change->dev_handle);
2015                                 continue;
2016                         }
2017                         if (sc->is_dpm_enable) {
2018                                 if (mt_entry->dpm_entry_num !=
2019                                     MPR_DPM_BAD_IDX) {
2020                                         dpm_idx = mt_entry->dpm_entry_num;
2021                                         dpm_entry = (Mpi2DriverMap0Entry_t *)
2022                                             ((u8 *)sc->dpm_pg0 + hdr_sz);
2023                                         dpm_entry += dpm_idx;
2024                                         missing_cnt = dpm_entry->
2025                                             MappingInformation &
2026                                             MPI2_DRVMAP0_MAPINFO_MISSING_MASK;
2027                                         temp64_var = dpm_entry->
2028                                             PhysicalIdentifier.High;
2029                                         temp64_var = (temp64_var << 32) |
2030                                            dpm_entry->PhysicalIdentifier.Low;
2031
2032                                         /*
2033                                          * If the Mapping Table's info is not
2034                                          * the same as the DPM entry, clear the
2035                                          * init_complete flag so that it's
2036                                          * updated.
2037                                          */
2038                                         if ((mt_entry->physical_id ==
2039                                             temp64_var) && !missing_cnt)
2040                                                 mt_entry->init_complete = 1;
2041                                         else
2042                                                 mt_entry->init_complete = 0;
2043                                 } else {
2044                                         dpm_idx = _mapping_get_free_dpm_idx(sc);
2045                                         mt_entry->init_complete = 0;
2046                                 }
2047                                 if (dpm_idx != MPR_DPM_BAD_IDX &&
2048                                     !mt_entry->init_complete) {
2049                                         mt_entry->dpm_entry_num = dpm_idx;
2050                                         dpm_entry = (Mpi2DriverMap0Entry_t *)
2051                                             ((u8 *)sc->dpm_pg0 + hdr_sz);
2052                                         dpm_entry += dpm_idx;
2053                                         dpm_entry->PhysicalIdentifier.Low =
2054                                             (0xFFFFFFFF &
2055                                             mt_entry->physical_id);
2056                                         dpm_entry->PhysicalIdentifier.High =
2057                                             (mt_entry->physical_id >> 32);
2058                                         dpm_entry->DeviceIndex = (U16) map_idx;
2059                                         dpm_entry->MappingInformation = 0;
2060                                         dpm_entry->PhysicalBitsMapping = 0;
2061                                         sc->dpm_entry_used[dpm_idx] = 1;
2062                                         sc->dpm_flush_entry[dpm_idx] = 1;
2063                                         port_change->is_processed = 1;
2064                                 } else if (dpm_idx == MPR_DPM_BAD_IDX) {
2065                                         port_change->is_processed = 1;
2066                                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING,
2067                                             "%s: failed to add the device with "
2068                                             "handle 0x%04x to persistent table "
2069                                             "because there is no free space "
2070                                             "available\n", __func__,
2071                                             port_change->dev_handle);
2072                                 }
2073                         }
2074                         mt_entry->init_complete = 1;
2075                 }
2076
2077                 port_change->is_processed = 1;
2078         }
2079         if (is_removed)
2080                 _mapping_clear_removed_entries(sc);
2081 }
2082
2083 /**
2084  * _mapping_flush_dpm_pages -Flush the DPM pages to NVRAM
2085  * @sc: per adapter object
2086  *
2087  * Returns nothing
2088  */
2089 static void
2090 _mapping_flush_dpm_pages(struct mpr_softc *sc)
2091 {
2092         Mpi2DriverMap0Entry_t *dpm_entry;
2093         Mpi2ConfigReply_t mpi_reply;
2094         Mpi2DriverMappingPage0_t config_page;
2095         u16 entry_num;
2096
2097         for (entry_num = 0; entry_num < sc->max_dpm_entries; entry_num++) {
2098                 if (!sc->dpm_flush_entry[entry_num])
2099                         continue;
2100                 memset(&config_page, 0, sizeof(Mpi2DriverMappingPage0_t));
2101                 memcpy(&config_page.Header, (u8 *)sc->dpm_pg0,
2102                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
2103                 dpm_entry = (Mpi2DriverMap0Entry_t *) ((u8 *)sc->dpm_pg0 +
2104                     sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
2105                 dpm_entry += entry_num;
2106                 dpm_entry->MappingInformation = htole16(dpm_entry->
2107                     MappingInformation);
2108                 dpm_entry->DeviceIndex = htole16(dpm_entry->DeviceIndex);
2109                 dpm_entry->PhysicalBitsMapping = htole32(dpm_entry->
2110                     PhysicalBitsMapping);
2111                 memcpy(&config_page.Entry, (u8 *)dpm_entry,
2112                     sizeof(Mpi2DriverMap0Entry_t));
2113                 /* TODO-How to handle failed writes? */
2114                 mpr_dprint(sc, MPR_MAPPING, "%s: Flushing DPM entry %d.\n",
2115                     __func__, entry_num);
2116                 if (mpr_config_set_dpm_pg0(sc, &mpi_reply, &config_page,
2117                     entry_num)) {
2118                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: Flush of "
2119                             "DPM entry %d for device failed\n", __func__,
2120                             entry_num);
2121                 } else
2122                         sc->dpm_flush_entry[entry_num] = 0;
2123                 dpm_entry->MappingInformation = le16toh(dpm_entry->
2124                     MappingInformation);
2125                 dpm_entry->DeviceIndex = le16toh(dpm_entry->DeviceIndex);
2126                 dpm_entry->PhysicalBitsMapping = le32toh(dpm_entry->
2127                     PhysicalBitsMapping);
2128         }
2129 }
2130
2131 /**
2132  * _mapping_allocate_memory- allocates the memory required for mapping tables
2133  * @sc: per adapter object
2134  *
2135  * Allocates the memory for all the tables required for host mapping
2136  *
2137  * Return 0 on success or non-zero on failure.
2138  */
2139 int
2140 mpr_mapping_allocate_memory(struct mpr_softc *sc)
2141 {
2142         uint32_t dpm_pg0_sz;
2143
2144         sc->mapping_table = malloc((sizeof(struct dev_mapping_table) *
2145             sc->max_devices), M_MPR, M_ZERO|M_NOWAIT);
2146         if (!sc->mapping_table)
2147                 goto free_resources;
2148
2149         sc->removal_table = malloc((sizeof(struct map_removal_table) *
2150             sc->max_devices), M_MPR, M_ZERO|M_NOWAIT);
2151         if (!sc->removal_table)
2152                 goto free_resources;
2153
2154         sc->enclosure_table = malloc((sizeof(struct enc_mapping_table) *
2155             sc->max_enclosures), M_MPR, M_ZERO|M_NOWAIT);
2156         if (!sc->enclosure_table)
2157                 goto free_resources;
2158
2159         sc->dpm_entry_used = malloc((sizeof(u8) * sc->max_dpm_entries),
2160             M_MPR, M_ZERO|M_NOWAIT);
2161         if (!sc->dpm_entry_used)
2162                 goto free_resources;
2163
2164         sc->dpm_flush_entry = malloc((sizeof(u8) * sc->max_dpm_entries),
2165             M_MPR, M_ZERO|M_NOWAIT);
2166         if (!sc->dpm_flush_entry)
2167                 goto free_resources;
2168
2169         dpm_pg0_sz = sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER) +
2170             (sc->max_dpm_entries * sizeof(MPI2_CONFIG_PAGE_DRIVER_MAP0_ENTRY));
2171
2172         sc->dpm_pg0 = malloc(dpm_pg0_sz, M_MPR, M_ZERO|M_NOWAIT);
2173         if (!sc->dpm_pg0) {
2174                 printf("%s: memory alloc failed for dpm page; disabling dpm\n",
2175                     __func__);
2176                 sc->is_dpm_enable = 0;
2177         }
2178
2179         return 0;
2180
2181 free_resources:
2182         free(sc->mapping_table, M_MPR);
2183         free(sc->removal_table, M_MPR);
2184         free(sc->enclosure_table, M_MPR);
2185         free(sc->dpm_entry_used, M_MPR);
2186         free(sc->dpm_flush_entry, M_MPR);
2187         free(sc->dpm_pg0, M_MPR);
2188         printf("%s: device initialization failed due to failure in mapping "
2189             "table memory allocation\n", __func__);
2190         return -1;
2191 }
2192
2193 /**
2194  * mpr_mapping_free_memory- frees the memory allocated for mapping tables
2195  * @sc: per adapter object
2196  *
2197  * Returns nothing.
2198  */
2199 void
2200 mpr_mapping_free_memory(struct mpr_softc *sc)
2201 {
2202         free(sc->mapping_table, M_MPR);
2203         free(sc->removal_table, M_MPR);
2204         free(sc->enclosure_table, M_MPR);
2205         free(sc->dpm_entry_used, M_MPR);
2206         free(sc->dpm_flush_entry, M_MPR);
2207         free(sc->dpm_pg0, M_MPR);
2208 }
2209
2210 static void
2211 _mapping_process_dpm_pg0(struct mpr_softc *sc)
2212 {
2213         u8 missing_cnt, enc_idx;
2214         u16 slot_id, entry_num, num_slots;
2215         u32 map_idx, dev_idx, start_idx, end_idx;
2216         struct dev_mapping_table *mt_entry;
2217         Mpi2DriverMap0Entry_t *dpm_entry;
2218         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
2219         u16 max_num_phy_ids = le16toh(sc->ioc_pg8.MaxNumPhysicalMappedIDs);
2220         struct enc_mapping_table *et_entry;
2221         u64 physical_id;
2222         u32 phy_bits = 0;
2223
2224         /*
2225          * start_idx and end_idx are only used for IR.
2226          */
2227         if (sc->ir_firmware)
2228                 _mapping_get_ir_maprange(sc, &start_idx, &end_idx);
2229
2230         /*
2231          * Look through all of the DPM entries that were read from the
2232          * controller and copy them over to the driver's internal table if they
2233          * have a non-zero ID. At this point, any ID with a value of 0 would be
2234          * invalid, so don't copy it.
2235          */
2236         mpr_dprint(sc, MPR_MAPPING, "%s: Start copy of %d DPM entries into the "
2237             "mapping table.\n", __func__, sc->max_dpm_entries);
2238         dpm_entry = (Mpi2DriverMap0Entry_t *) ((uint8_t *) sc->dpm_pg0 +
2239             sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
2240         for (entry_num = 0; entry_num < sc->max_dpm_entries; entry_num++, 
2241             dpm_entry++) {
2242                 physical_id = dpm_entry->PhysicalIdentifier.High;
2243                 physical_id = (physical_id << 32) | 
2244                     dpm_entry->PhysicalIdentifier.Low;
2245                 if (!physical_id) {
2246                         sc->dpm_entry_used[entry_num] = 0;
2247                         continue;
2248                 }
2249                 sc->dpm_entry_used[entry_num] = 1;
2250                 dpm_entry->MappingInformation = le16toh(dpm_entry->
2251                     MappingInformation);
2252                 missing_cnt = dpm_entry->MappingInformation &
2253                     MPI2_DRVMAP0_MAPINFO_MISSING_MASK;
2254                 dev_idx = le16toh(dpm_entry->DeviceIndex);
2255                 phy_bits = le32toh(dpm_entry->PhysicalBitsMapping);
2256
2257                 /*
2258                  * Volumes are at special locations in the mapping table so
2259                  * account for that. Volume mapping table entries do not depend
2260                  * on the type of mapping, so continue the loop after adding
2261                  * volumes to the mapping table.
2262                  */
2263                 if (sc->ir_firmware && (dev_idx >= start_idx) &&
2264                     (dev_idx <= end_idx)) {
2265                         mt_entry = &sc->mapping_table[dev_idx];
2266                         mt_entry->physical_id =
2267                             dpm_entry->PhysicalIdentifier.High;
2268                         mt_entry->physical_id = (mt_entry->physical_id << 32) |
2269                             dpm_entry->PhysicalIdentifier.Low;
2270                         mt_entry->id = dev_idx;
2271                         mt_entry->missing_count = missing_cnt;
2272                         mt_entry->dpm_entry_num = entry_num;
2273                         mt_entry->device_info = MPR_DEV_RESERVED;
2274                         continue;
2275                 }
2276                 if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
2277                     MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
2278
2279                         /*
2280                          * The dev_idx for an enclosure is the start index. If
2281                          * the start index is within the controller's default
2282                          * enclosure area, set the number of slots for this
2283                          * enclosure to the max allowed. Otherwise, it should be
2284                          * a normal enclosure and the number of slots is in the
2285                          * DPM entry's Mapping Information.
2286                          */
2287                         if (dev_idx < (sc->num_rsvd_entries +
2288                             max_num_phy_ids)) {
2289                                 slot_id = 0;
2290                                 if (ioc_pg8_flags &
2291                                     MPI2_IOCPAGE8_FLAGS_DA_START_SLOT_1)
2292                                         slot_id = 1;
2293                                 num_slots = max_num_phy_ids;
2294                         } else {
2295                                 slot_id = 0;
2296                                 num_slots = dpm_entry->MappingInformation &
2297                                     MPI2_DRVMAP0_MAPINFO_SLOT_MASK;
2298                                 num_slots >>= MPI2_DRVMAP0_MAPINFO_SLOT_SHIFT;
2299                         }
2300                         enc_idx = sc->num_enc_table_entries;
2301                         if (enc_idx >= sc->max_enclosures) {
2302                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
2303                                     "Number of enclosure entries in DPM exceed "
2304                                     "the max allowed of %d.\n", __func__,
2305                                     sc->max_enclosures);
2306                                 break;
2307                         }
2308                         sc->num_enc_table_entries++;
2309                         et_entry = &sc->enclosure_table[enc_idx];
2310                         physical_id = dpm_entry->PhysicalIdentifier.High;
2311                         et_entry->enclosure_id = (physical_id << 32) |
2312                             dpm_entry->PhysicalIdentifier.Low;
2313                         et_entry->start_index = dev_idx;
2314                         et_entry->dpm_entry_num = entry_num;
2315                         et_entry->num_slots = num_slots;
2316                         et_entry->start_slot = slot_id;
2317                         et_entry->missing_count = missing_cnt;
2318                         et_entry->phy_bits = phy_bits;
2319
2320                         /*
2321                          * Initialize all entries for this enclosure in the
2322                          * mapping table and mark them as reserved. The actual
2323                          * devices have not been processed yet but when they are
2324                          * they will use these entries. If an entry is found
2325                          * that already has a valid DPM index, the mapping table
2326                          * is corrupt. This can happen if the mapping type is
2327                          * changed without clearing all of the DPM entries in
2328                          * the controller.
2329                          */
2330                         mt_entry = &sc->mapping_table[dev_idx];
2331                         for (map_idx = dev_idx; map_idx < (dev_idx + num_slots);
2332                             map_idx++, mt_entry++) {
2333                                 if (mt_entry->dpm_entry_num !=
2334                                     MPR_DPM_BAD_IDX) {
2335                                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING,
2336                                             "%s: Conflict in mapping table for "
2337                                             " enclosure %d\n", __func__,
2338                                             enc_idx);
2339                                         break;
2340                                 }
2341                                 physical_id =
2342                                     dpm_entry->PhysicalIdentifier.High;
2343                                 mt_entry->physical_id = (physical_id << 32) |
2344                                     dpm_entry->PhysicalIdentifier.Low;
2345                                 mt_entry->phy_bits = phy_bits;
2346                                 mt_entry->id = dev_idx;
2347                                 mt_entry->dpm_entry_num = entry_num;
2348                                 mt_entry->missing_count = missing_cnt;
2349                                 mt_entry->device_info = MPR_DEV_RESERVED;
2350                         }
2351                 } else if ((ioc_pg8_flags &
2352                     MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
2353                     MPI2_IOCPAGE8_FLAGS_DEVICE_PERSISTENCE_MAPPING) {
2354
2355                         /*
2356                          * Device mapping, so simply copy the DPM entries to the
2357                          * mapping table, but check for a corrupt mapping table
2358                          * (as described above in Enc/Slot mapping).
2359                          */
2360                         map_idx = dev_idx;
2361                         mt_entry = &sc->mapping_table[map_idx];
2362                         if (mt_entry->dpm_entry_num != MPR_DPM_BAD_IDX) {
2363                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
2364                                     "Conflict in mapping table for device %d\n",
2365                                     __func__, map_idx);
2366                                 break;
2367                         }
2368                         physical_id = dpm_entry->PhysicalIdentifier.High;
2369                         mt_entry->physical_id = (physical_id << 32) |
2370                             dpm_entry->PhysicalIdentifier.Low;
2371                         mt_entry->phy_bits = phy_bits;
2372                         mt_entry->id = dev_idx;
2373                         mt_entry->missing_count = missing_cnt;
2374                         mt_entry->dpm_entry_num = entry_num;
2375                         mt_entry->device_info = MPR_DEV_RESERVED;
2376                 }
2377         } /*close the loop for DPM table */
2378 }
2379
2380 /*
2381  * mpr_mapping_check_devices - start of the day check for device availabilty
2382  * @sc: per adapter object
2383  *
2384  * Returns nothing.
2385  */
2386 void
2387 mpr_mapping_check_devices(void *data)
2388 {
2389         u32 i;
2390         struct dev_mapping_table *mt_entry;
2391         struct mpr_softc *sc = (struct mpr_softc *)data;
2392         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
2393         struct enc_mapping_table *et_entry;
2394         u32 start_idx = 0, end_idx = 0;
2395         u8 stop_device_checks = 0;
2396
2397         MPR_FUNCTRACE(sc);
2398
2399         /*
2400          * Clear this flag so that this function is never called again except
2401          * within this function if the check needs to be done again. The
2402          * purpose is to check for missing devices that are currently in the
2403          * mapping table so do this only at driver init after discovery.
2404          */
2405         sc->track_mapping_events = 0;
2406
2407         /*
2408          * callout synchronization
2409          * This is used to prevent race conditions for the callout. 
2410          */
2411         mpr_dprint(sc, MPR_MAPPING, "%s: Start check for missing devices.\n",
2412             __func__);
2413         mtx_assert(&sc->mpr_mtx, MA_OWNED);
2414         if ((callout_pending(&sc->device_check_callout)) ||
2415             (!callout_active(&sc->device_check_callout))) {
2416                 mpr_dprint(sc, MPR_MAPPING, "%s: Device Check Callout is "
2417                     "already pending or not active.\n", __func__);
2418                 return;
2419         }
2420         callout_deactivate(&sc->device_check_callout);
2421
2422         /*
2423          * Use callout to check if any devices in the mapping table have been
2424          * processed yet. If ALL devices are marked as not init_complete, no
2425          * devices have been processed and mapped. Until devices are mapped
2426          * there's no reason to mark them as missing. Continue resetting this
2427          * callout until devices have been mapped.
2428          */
2429         if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
2430             MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
2431                 et_entry = sc->enclosure_table;
2432                 for (i = 0; i < sc->num_enc_table_entries; i++, et_entry++) {
2433                         if (et_entry->init_complete) {
2434                                 stop_device_checks = 1;
2435                                 break;
2436                         }
2437                 }
2438         } else if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
2439             MPI2_IOCPAGE8_FLAGS_DEVICE_PERSISTENCE_MAPPING) {
2440                 mt_entry = sc->mapping_table;
2441                 for (i = 0; i < sc->max_devices; i++, mt_entry++) {
2442                         if (mt_entry->init_complete) {
2443                                 stop_device_checks = 1;
2444                                 break;
2445                         }
2446                 }
2447         }
2448
2449         /*
2450          * Setup another callout check after a delay. Keep doing this until
2451          * devices are mapped.
2452          */
2453         if (!stop_device_checks) {
2454                 mpr_dprint(sc, MPR_MAPPING, "%s: No devices have been mapped. "
2455                     "Reset callout to check again after a %d second delay.\n",
2456                     __func__, MPR_MISSING_CHECK_DELAY);
2457                 callout_reset(&sc->device_check_callout,
2458                     MPR_MISSING_CHECK_DELAY * hz, mpr_mapping_check_devices,
2459                     sc);
2460                 return;
2461         }
2462         mpr_dprint(sc, MPR_MAPPING, "%s: Device check complete.\n", __func__);
2463
2464         /*
2465          * Depending on the mapping type, check if devices have been processed
2466          * and update their missing counts if not processed.
2467          */
2468         if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
2469             MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING) {
2470                 et_entry = sc->enclosure_table;
2471                 for (i = 0; i < sc->num_enc_table_entries; i++, et_entry++) {
2472                         if (!et_entry->init_complete) {
2473                                 if (et_entry->missing_count <
2474                                     MPR_MAX_MISSING_COUNT) {
2475                                         mpr_dprint(sc, MPR_MAPPING, "%s: "
2476                                             "Enclosure %d is missing from the "
2477                                             "topology. Update its missing "
2478                                             "count.\n", __func__, i);
2479                                         et_entry->missing_count++;
2480                                         if (et_entry->dpm_entry_num !=
2481                                             MPR_DPM_BAD_IDX) {
2482                                                 _mapping_commit_enc_entry(sc,
2483                                                     et_entry);
2484                                         }
2485                                 }
2486                                 et_entry->init_complete = 1;
2487                         }
2488                 }
2489                 if (!sc->ir_firmware)
2490                         return;
2491                 _mapping_get_ir_maprange(sc, &start_idx, &end_idx);
2492                 mt_entry = &sc->mapping_table[start_idx];
2493         } else if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) ==
2494             MPI2_IOCPAGE8_FLAGS_DEVICE_PERSISTENCE_MAPPING) {
2495                 start_idx = 0;
2496                 end_idx = sc->max_devices - 1;
2497                 mt_entry = sc->mapping_table;
2498         }
2499
2500         /*
2501          * The start and end indices have been set above according to the
2502          * mapping type. Go through these mappings and update any entries that
2503          * do not have the init_complete flag set, which means they are missing.
2504          */
2505         if (end_idx == 0)
2506                 return;
2507         for (i = start_idx; i < (end_idx + 1); i++, mt_entry++) {
2508                 if (mt_entry->device_info & MPR_DEV_RESERVED
2509                     && !mt_entry->physical_id)
2510                         mt_entry->init_complete = 1;
2511                 else if (mt_entry->device_info & MPR_DEV_RESERVED) {
2512                         if (!mt_entry->init_complete) {
2513                                 mpr_dprint(sc, MPR_MAPPING, "%s: Device in "
2514                                     "mapping table at index %d is missing from "
2515                                     "topology. Update its missing count.\n",
2516                                     __func__, i);
2517                                 if (mt_entry->missing_count <
2518                                     MPR_MAX_MISSING_COUNT) {
2519                                         mt_entry->missing_count++;
2520                                         if (mt_entry->dpm_entry_num !=
2521                                             MPR_DPM_BAD_IDX) {
2522                                                 _mapping_commit_map_entry(sc,
2523                                                     mt_entry);
2524                                         }
2525                                 }
2526                                 mt_entry->init_complete = 1;
2527                         }
2528                 }
2529         }
2530 }
2531
2532 /**
2533  * mpr_mapping_initialize - initialize mapping tables
2534  * @sc: per adapter object
2535  *
2536  * Read controller persitant mapping tables into internal data area.
2537  *
2538  * Return 0 for success or non-zero for failure.
2539  */
2540 int
2541 mpr_mapping_initialize(struct mpr_softc *sc)
2542 {
2543         uint16_t volume_mapping_flags, dpm_pg0_sz;
2544         uint32_t i;
2545         Mpi2ConfigReply_t mpi_reply;
2546         int error;
2547         uint8_t retry_count;
2548         uint16_t ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
2549
2550         /* The additional 1 accounts for the virtual enclosure
2551          * created for the controller
2552          */
2553         sc->max_enclosures = sc->facts->MaxEnclosures + 1;
2554         sc->max_expanders = sc->facts->MaxSasExpanders;
2555         sc->max_volumes = sc->facts->MaxVolumes;
2556         sc->max_devices = sc->facts->MaxTargets + sc->max_volumes;
2557         sc->pending_map_events = 0;
2558         sc->num_enc_table_entries = 0;
2559         sc->num_rsvd_entries = 0;
2560         sc->max_dpm_entries = sc->ioc_pg8.MaxPersistentEntries;
2561         sc->is_dpm_enable = (sc->max_dpm_entries) ? 1 : 0;
2562         sc->track_mapping_events = 0;
2563
2564         mpr_dprint(sc, MPR_MAPPING, "%s: Mapping table has a max of %d entries "
2565             "and DPM has a max of %d entries.\n", __func__, sc->max_devices,
2566             sc->max_dpm_entries);
2567         
2568         if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_DISABLE_PERSISTENT_MAPPING)
2569                 sc->is_dpm_enable = 0;
2570
2571         if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
2572                 sc->num_rsvd_entries = 1;
2573
2574         volume_mapping_flags = sc->ioc_pg8.IRVolumeMappingFlags &
2575             MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
2576         if (sc->ir_firmware && (volume_mapping_flags ==
2577             MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING))
2578                 sc->num_rsvd_entries += sc->max_volumes;
2579
2580         error = mpr_mapping_allocate_memory(sc);
2581         if (error)
2582                 return (error);
2583
2584         for (i = 0; i < sc->max_devices; i++)
2585                 _mapping_clear_map_entry(sc->mapping_table + i);
2586
2587         for (i = 0; i < sc->max_enclosures; i++)
2588                 _mapping_clear_enc_entry(sc->enclosure_table + i);
2589
2590         for (i = 0; i < sc->max_devices; i++) {
2591                 sc->removal_table[i].dev_handle = 0;
2592                 sc->removal_table[i].dpm_entry_num = MPR_DPM_BAD_IDX;
2593         }
2594
2595         memset(sc->dpm_entry_used, 0, sc->max_dpm_entries);
2596         memset(sc->dpm_flush_entry, 0, sc->max_dpm_entries);
2597
2598         if (sc->is_dpm_enable) {
2599                 dpm_pg0_sz = sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER) +
2600                     (sc->max_dpm_entries *
2601                      sizeof(MPI2_CONFIG_PAGE_DRIVER_MAP0_ENTRY));
2602                 retry_count = 0;
2603
2604 retry_read_dpm:
2605                 if (mpr_config_get_dpm_pg0(sc, &mpi_reply, sc->dpm_pg0,
2606                     dpm_pg0_sz)) {
2607                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: DPM page "
2608                             "read failed.\n", __func__);
2609                         if (retry_count < 3) {
2610                                 retry_count++;
2611                                 goto retry_read_dpm;
2612                         }
2613                         sc->is_dpm_enable = 0;
2614                 }
2615         }
2616
2617         if (sc->is_dpm_enable)
2618                 _mapping_process_dpm_pg0(sc);
2619         else {
2620                 mpr_dprint(sc, MPR_MAPPING, "%s: DPM processing is disabled. "
2621                     "Device mappings will not persist across reboots or "
2622                     "resets.\n", __func__);
2623         }
2624
2625         sc->track_mapping_events = 1;
2626         return 0;
2627 }
2628
2629 /**
2630  * mpr_mapping_exit - clear mapping table and associated memory
2631  * @sc: per adapter object
2632  *
2633  * Returns nothing.
2634  */
2635 void
2636 mpr_mapping_exit(struct mpr_softc *sc)
2637 {
2638         _mapping_flush_dpm_pages(sc);
2639         mpr_mapping_free_memory(sc);
2640 }
2641
2642 /**
2643  * mpr_mapping_get_tid - return the target id for sas device and handle
2644  * @sc: per adapter object
2645  * @sas_address: sas address of the device
2646  * @handle: device handle
2647  *
2648  * Returns valid target ID on success or BAD_ID.
2649  */
2650 unsigned int
2651 mpr_mapping_get_tid(struct mpr_softc *sc, uint64_t sas_address, u16 handle)
2652 {
2653         u32 map_idx;
2654         struct dev_mapping_table *mt_entry;
2655
2656         for (map_idx = 0; map_idx < sc->max_devices; map_idx++) {
2657                 mt_entry = &sc->mapping_table[map_idx];
2658                 if (mt_entry->dev_handle == handle && mt_entry->physical_id ==
2659                     sas_address)
2660                         return mt_entry->id;
2661         }
2662
2663         return MPR_MAP_BAD_ID;
2664 }
2665
2666 /**
2667  * mpr_mapping_get_tid_from_handle - find a target id in mapping table using
2668  * only the dev handle.  This is just a wrapper function for the local function
2669  * _mapping_get_mt_idx_from_handle.
2670  * @sc: per adapter object
2671  * @handle: device handle
2672  *
2673  * Returns valid target ID on success or BAD_ID.
2674  */
2675 unsigned int
2676 mpr_mapping_get_tid_from_handle(struct mpr_softc *sc, u16 handle)
2677 {
2678         return (_mapping_get_mt_idx_from_handle(sc, handle));
2679 }
2680
2681 /**
2682  * mpr_mapping_get_raid_tid - return the target id for raid device
2683  * @sc: per adapter object
2684  * @wwid: world wide identifier for raid volume
2685  * @volHandle: volume device handle
2686  *
2687  * Returns valid target ID on success or BAD_ID.
2688  */
2689 unsigned int
2690 mpr_mapping_get_raid_tid(struct mpr_softc *sc, u64 wwid, u16 volHandle)
2691 {
2692         u32 start_idx, end_idx, map_idx;
2693         struct dev_mapping_table *mt_entry;
2694
2695         _mapping_get_ir_maprange(sc, &start_idx, &end_idx);
2696         mt_entry = &sc->mapping_table[start_idx];
2697         for (map_idx  = start_idx; map_idx <= end_idx; map_idx++, mt_entry++) {
2698                 if (mt_entry->dev_handle == volHandle &&
2699                     mt_entry->physical_id == wwid)
2700                         return mt_entry->id;
2701         }
2702
2703         return MPR_MAP_BAD_ID;
2704 }
2705
2706 /**
2707  * mpr_mapping_get_raid_tid_from_handle - find raid device in mapping table
2708  * using only the volume dev handle.  This is just a wrapper function for the
2709  * local function _mapping_get_ir_mt_idx_from_handle.
2710  * @sc: per adapter object
2711  * @volHandle: volume device handle
2712  *
2713  * Returns valid target ID on success or BAD_ID.
2714  */
2715 unsigned int
2716 mpr_mapping_get_raid_tid_from_handle(struct mpr_softc *sc, u16 volHandle)
2717 {
2718         return (_mapping_get_ir_mt_idx_from_handle(sc, volHandle));
2719 }
2720
2721 /**
2722  * mpr_mapping_enclosure_dev_status_change_event - handle enclosure events
2723  * @sc: per adapter object
2724  * @event_data: event data payload
2725  *
2726  * Return nothing.
2727  */
2728 void
2729 mpr_mapping_enclosure_dev_status_change_event(struct mpr_softc *sc,
2730     Mpi2EventDataSasEnclDevStatusChange_t *event_data)
2731 {
2732         u8 enc_idx, missing_count;
2733         struct enc_mapping_table *et_entry;
2734         Mpi2DriverMap0Entry_t *dpm_entry;
2735         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
2736         u8 map_shift = MPI2_DRVMAP0_MAPINFO_SLOT_SHIFT;
2737         u8 update_phy_bits = 0;
2738         u32 saved_phy_bits;
2739         uint64_t temp64_var;
2740
2741         if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE) !=
2742             MPI2_IOCPAGE8_FLAGS_ENCLOSURE_SLOT_MAPPING)
2743                 goto out;
2744
2745         dpm_entry = (Mpi2DriverMap0Entry_t *)((u8 *)sc->dpm_pg0 +
2746             sizeof(MPI2_CONFIG_EXTENDED_PAGE_HEADER));
2747
2748         if (event_data->ReasonCode == MPI2_EVENT_SAS_ENCL_RC_ADDED) {
2749                 if (!event_data->NumSlots) {
2750                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: Enclosure "
2751                             "with handle = 0x%x reported 0 slots.\n", __func__,
2752                             le16toh(event_data->EnclosureHandle));
2753                         goto out;
2754                 }
2755                 temp64_var = event_data->EnclosureLogicalID.High;
2756                 temp64_var = (temp64_var << 32) |
2757                     event_data->EnclosureLogicalID.Low;
2758                 enc_idx = _mapping_get_enc_idx_from_id(sc, temp64_var,
2759                     event_data->PhyBits);
2760
2761                 /*
2762                  * If the Added enclosure is already in the Enclosure Table,
2763                  * make sure that all the the enclosure info is up to date. If
2764                  * the enclosure was missing and has just been added back, or if
2765                  * the enclosure's Phy Bits have changed, clear the missing
2766                  * count and update the Phy Bits in the mapping table and in the
2767                  * DPM, if it's being used.
2768                  */
2769                 if (enc_idx != MPR_ENCTABLE_BAD_IDX) {
2770                         et_entry = &sc->enclosure_table[enc_idx];
2771                         if (et_entry->init_complete &&
2772                             !et_entry->missing_count) {
2773                                 mpr_dprint(sc, MPR_MAPPING, "%s: Enclosure %d "
2774                                     "is already present with handle = 0x%x\n",
2775                                     __func__, enc_idx, et_entry->enc_handle);
2776                                 goto out;
2777                         }
2778                         et_entry->enc_handle = le16toh(event_data->
2779                             EnclosureHandle);
2780                         et_entry->start_slot = le16toh(event_data->StartSlot);
2781                         saved_phy_bits = et_entry->phy_bits;
2782                         et_entry->phy_bits |= le32toh(event_data->PhyBits);
2783                         if (saved_phy_bits != et_entry->phy_bits)
2784                                 update_phy_bits = 1;
2785                         if (et_entry->missing_count || update_phy_bits) {
2786                                 et_entry->missing_count = 0;
2787                                 if (sc->is_dpm_enable &&
2788                                     et_entry->dpm_entry_num !=
2789                                     MPR_DPM_BAD_IDX) {
2790                                         dpm_entry += et_entry->dpm_entry_num;
2791                                         missing_count =
2792                                             (u8)(dpm_entry->MappingInformation &
2793                                             MPI2_DRVMAP0_MAPINFO_MISSING_MASK);
2794                                         if (missing_count || update_phy_bits) {
2795                                                 dpm_entry->MappingInformation
2796                                                     = et_entry->num_slots;
2797                                                 dpm_entry->MappingInformation
2798                                                     <<= map_shift;
2799                                                 dpm_entry->PhysicalBitsMapping
2800                                                     = et_entry->phy_bits;
2801                                                 sc->dpm_flush_entry[et_entry->
2802                                                     dpm_entry_num] = 1;
2803                                         }
2804                                 }
2805                         }
2806                 } else {
2807                         /*
2808                          * This is a new enclosure that is being added.
2809                          * Initialize the Enclosure Table entry. It will be
2810                          * finalized when a device is added for the enclosure
2811                          * and the enclosure has enough space in the Mapping
2812                          * Table to map its devices.
2813                          */
2814                         enc_idx = sc->num_enc_table_entries;
2815                         if (enc_idx >= sc->max_enclosures) {
2816                                 mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: "
2817                                     "Enclosure cannot be added to mapping "
2818                                     "table because it's full.\n", __func__);
2819                                 goto out;
2820                         }
2821                         sc->num_enc_table_entries++;
2822                         et_entry = &sc->enclosure_table[enc_idx];
2823                         et_entry->enc_handle = le16toh(event_data->
2824                             EnclosureHandle);
2825                         et_entry->enclosure_id = le64toh(event_data->
2826                             EnclosureLogicalID.High);
2827                         et_entry->enclosure_id =
2828                             ((et_entry->enclosure_id << 32) |
2829                             le64toh(event_data->EnclosureLogicalID.Low));
2830                         et_entry->start_index = MPR_MAPTABLE_BAD_IDX;
2831                         et_entry->dpm_entry_num = MPR_DPM_BAD_IDX;
2832                         et_entry->num_slots = le16toh(event_data->NumSlots);
2833                         et_entry->start_slot = le16toh(event_data->StartSlot);
2834                         et_entry->phy_bits = le32toh(event_data->PhyBits);
2835                 }
2836                 et_entry->init_complete = 1;
2837         } else if (event_data->ReasonCode ==
2838             MPI2_EVENT_SAS_ENCL_RC_NOT_RESPONDING) {
2839                 /*
2840                  * An enclosure was removed. Update its missing count and then
2841                  * update the DPM entry with the new missing count for the
2842                  * enclosure.
2843                  */
2844                 enc_idx = _mapping_get_enc_idx_from_handle(sc,
2845                     le16toh(event_data->EnclosureHandle));
2846                 if (enc_idx == MPR_ENCTABLE_BAD_IDX) {
2847                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING, "%s: Cannot "
2848                             "unmap enclosure %d because it has already been "
2849                             "deleted.\n", __func__, enc_idx);
2850                         goto out;
2851                 }
2852                 et_entry = &sc->enclosure_table[enc_idx];
2853                 if (et_entry->missing_count < MPR_MAX_MISSING_COUNT)
2854                         et_entry->missing_count++;
2855                 if (sc->is_dpm_enable &&
2856                     et_entry->dpm_entry_num != MPR_DPM_BAD_IDX) {
2857                         dpm_entry += et_entry->dpm_entry_num;
2858                         dpm_entry->MappingInformation = et_entry->num_slots;
2859                         dpm_entry->MappingInformation <<= map_shift;
2860                         dpm_entry->MappingInformation |=
2861                             et_entry->missing_count;
2862                         sc->dpm_flush_entry[et_entry->dpm_entry_num] = 1;
2863                 }
2864                 et_entry->init_complete = 1;
2865         }
2866
2867 out:
2868         _mapping_flush_dpm_pages(sc);
2869         if (sc->pending_map_events)
2870                 sc->pending_map_events--;
2871 }
2872
2873 /**
2874  * mpr_mapping_topology_change_event - handle topology change events
2875  * @sc: per adapter object
2876  * @event_data: event data payload
2877  *
2878  * Returns nothing.
2879  */
2880 void
2881 mpr_mapping_topology_change_event(struct mpr_softc *sc,
2882     Mpi2EventDataSasTopologyChangeList_t *event_data)
2883 {
2884         struct _map_topology_change topo_change;
2885         struct _map_phy_change *phy_change;
2886         Mpi2EventSasTopoPhyEntry_t *event_phy_change;
2887         u8 i, num_entries;
2888
2889         topo_change.enc_handle = le16toh(event_data->EnclosureHandle);
2890         topo_change.exp_handle = le16toh(event_data->ExpanderDevHandle);
2891         num_entries = event_data->NumEntries;
2892         topo_change.num_entries = num_entries;
2893         topo_change.start_phy_num = event_data->StartPhyNum;
2894         topo_change.num_phys = event_data->NumPhys;
2895         topo_change.exp_status = event_data->ExpStatus;
2896         event_phy_change = event_data->PHY;
2897         topo_change.phy_details = NULL;
2898
2899         if (!num_entries)
2900                 goto out;
2901         phy_change = malloc(sizeof(struct _map_phy_change) * num_entries,
2902             M_MPR, M_NOWAIT|M_ZERO);
2903         topo_change.phy_details = phy_change;
2904         if (!phy_change)
2905                 goto out;
2906         for (i = 0; i < num_entries; i++, event_phy_change++, phy_change++) {
2907                 phy_change->dev_handle = le16toh(event_phy_change->
2908                     AttachedDevHandle);
2909                 phy_change->reason = event_phy_change->PhyStatus &
2910                     MPI2_EVENT_SAS_TOPO_RC_MASK;
2911         }
2912         _mapping_update_missing_count(sc, &topo_change);
2913         _mapping_get_dev_info(sc, &topo_change);
2914         _mapping_clear_removed_entries(sc);
2915         _mapping_add_new_device(sc, &topo_change);
2916
2917 out:
2918         free(topo_change.phy_details, M_MPR);
2919         _mapping_flush_dpm_pages(sc);
2920         if (sc->pending_map_events)
2921                 sc->pending_map_events--;
2922 }
2923
2924 /**
2925  * mpr_mapping_pcie_topology_change_event - handle PCIe topology change events
2926  * @sc: per adapter object
2927  * @event_data: event data payload
2928  *
2929  * Returns nothing.
2930  */
2931 void
2932 mpr_mapping_pcie_topology_change_event(struct mpr_softc *sc,
2933     Mpi26EventDataPCIeTopologyChangeList_t *event_data)
2934 {
2935         struct _map_pcie_topology_change topo_change;
2936         struct _map_port_change *port_change;
2937         Mpi26EventPCIeTopoPortEntry_t *event_port_change;
2938         u8 i, num_entries;
2939
2940         topo_change.switch_dev_handle = le16toh(event_data->SwitchDevHandle);
2941         topo_change.enc_handle = le16toh(event_data->EnclosureHandle);
2942         num_entries = event_data->NumEntries;
2943         topo_change.num_entries = num_entries;
2944         topo_change.start_port_num = event_data->StartPortNum;
2945         topo_change.num_ports = event_data->NumPorts;
2946         topo_change.switch_status = event_data->SwitchStatus;
2947         event_port_change = event_data->PortEntry;
2948         topo_change.port_details = NULL;
2949
2950         if (!num_entries)
2951                 goto out;
2952         port_change = malloc(sizeof(struct _map_port_change) * num_entries,
2953             M_MPR, M_NOWAIT|M_ZERO);
2954         topo_change.port_details = port_change;
2955         if (!port_change)
2956                 goto out;
2957         for (i = 0; i < num_entries; i++, event_port_change++, port_change++) {
2958                 port_change->dev_handle = le16toh(event_port_change->
2959                     AttachedDevHandle);
2960                 port_change->reason = event_port_change->PortStatus;
2961         }
2962         _mapping_update_pcie_missing_count(sc, &topo_change);
2963         _mapping_get_pcie_dev_info(sc, &topo_change);
2964         _mapping_clear_removed_entries(sc);
2965         _mapping_add_new_pcie_device(sc, &topo_change);
2966
2967 out:
2968         free(topo_change.port_details, M_MPR);
2969         _mapping_flush_dpm_pages(sc);
2970         if (sc->pending_map_events)
2971                 sc->pending_map_events--;
2972 }
2973
2974 /**
2975  * mpr_mapping_ir_config_change_event - handle IR config change list events
2976  * @sc: per adapter object
2977  * @event_data: event data payload
2978  *
2979  * Returns nothing.
2980  */
2981 void
2982 mpr_mapping_ir_config_change_event(struct mpr_softc *sc,
2983     Mpi2EventDataIrConfigChangeList_t *event_data)
2984 {
2985         Mpi2EventIrConfigElement_t *element;
2986         int i;
2987         u64 *wwid_table;
2988         u32 map_idx, flags;
2989         struct dev_mapping_table *mt_entry;
2990         u16 element_flags;
2991
2992         wwid_table = malloc(sizeof(u64) * event_data->NumElements, M_MPR,
2993             M_NOWAIT | M_ZERO);
2994         if (!wwid_table)
2995                 goto out;
2996         element = (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
2997         flags = le32toh(event_data->Flags);
2998
2999         /*
3000          * For volume changes, get the WWID for the volume and put it in a
3001          * table to be used in the processing of the IR change event.
3002          */
3003         for (i = 0; i < event_data->NumElements; i++, element++) {
3004                 element_flags = le16toh(element->ElementFlags);
3005                 if ((element->ReasonCode != MPI2_EVENT_IR_CHANGE_RC_ADDED) &&
3006                     (element->ReasonCode != MPI2_EVENT_IR_CHANGE_RC_REMOVED) &&
3007                     (element->ReasonCode != MPI2_EVENT_IR_CHANGE_RC_NO_CHANGE)
3008                     && (element->ReasonCode !=
3009                         MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED))
3010                         continue;
3011                 if ((element_flags &
3012                     MPI2_EVENT_IR_CHANGE_EFLAGS_ELEMENT_TYPE_MASK) ==
3013                     MPI2_EVENT_IR_CHANGE_EFLAGS_VOLUME_ELEMENT) {
3014                         mpr_config_get_volume_wwid(sc,
3015                             le16toh(element->VolDevHandle), &wwid_table[i]);
3016                 }
3017         }
3018
3019         /*
3020          * Check the ReasonCode for each element in the IR event and Add/Remove
3021          * Volumes or Physical Disks of Volumes to/from the mapping table. Use
3022          * the WWIDs gotten above in wwid_table.
3023          */
3024         if (flags == MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG)
3025                 goto out;
3026         else {
3027                 element = (Mpi2EventIrConfigElement_t *)&event_data->
3028                     ConfigElement[0];
3029                 for (i = 0; i < event_data->NumElements; i++, element++) {
3030                         if (element->ReasonCode ==
3031                             MPI2_EVENT_IR_CHANGE_RC_ADDED ||
3032                             element->ReasonCode ==
3033                             MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED) {
3034                                 map_idx = _mapping_get_ir_mt_idx_from_wwid
3035                                     (sc, wwid_table[i]);
3036                                 if (map_idx != MPR_MAPTABLE_BAD_IDX) {
3037                                         /*
3038                                          * The volume is already in the mapping
3039                                          * table. Just update it's info.
3040                                          */
3041                                         mt_entry = &sc->mapping_table[map_idx];
3042                                         mt_entry->id = map_idx;
3043                                         mt_entry->dev_handle = le16toh
3044                                             (element->VolDevHandle);
3045                                         mt_entry->device_info =
3046                                             MPR_DEV_RESERVED | MPR_MAP_IN_USE;
3047                                         _mapping_update_ir_missing_cnt(sc,
3048                                             map_idx, element, wwid_table[i]);
3049                                         continue;
3050                                 }
3051
3052                                 /*
3053                                  * Volume is not in mapping table yet. Find a
3054                                  * free entry in the mapping table at the
3055                                  * volume mapping locations. If no entries are
3056                                  * available, this is an error because it means
3057                                  * there are more volumes than can be mapped
3058                                  * and that should never happen for volumes.
3059                                  */
3060                                 map_idx = _mapping_get_free_ir_mt_idx(sc);
3061                                 if (map_idx == MPR_MAPTABLE_BAD_IDX)
3062                                 {
3063                                         mpr_dprint(sc, MPR_ERROR | MPR_MAPPING,
3064                                             "%s: failed to add the volume with "
3065                                             "handle 0x%04x because there is no "
3066                                             "free space available in the "
3067                                             "mapping table\n", __func__,
3068                                             le16toh(element->VolDevHandle));
3069                                         continue;
3070                                 }
3071                                 mt_entry = &sc->mapping_table[map_idx];
3072                                 mt_entry->physical_id = wwid_table[i];
3073                                 mt_entry->id = map_idx;
3074                                 mt_entry->dev_handle = le16toh(element->
3075                                     VolDevHandle);
3076                                 mt_entry->device_info = MPR_DEV_RESERVED |
3077                                     MPR_MAP_IN_USE;
3078                                 _mapping_update_ir_missing_cnt(sc, map_idx,
3079                                     element, wwid_table[i]);
3080                         } else if (element->ReasonCode ==
3081                             MPI2_EVENT_IR_CHANGE_RC_REMOVED) {
3082                                 map_idx = _mapping_get_ir_mt_idx_from_wwid(sc,
3083                                     wwid_table[i]);
3084                                 if (map_idx == MPR_MAPTABLE_BAD_IDX) {
3085                                         mpr_dprint(sc, MPR_MAPPING,"%s: Failed "
3086                                             "to remove a volume because it has "
3087                                             "already been removed.\n",
3088                                             __func__);
3089                                         continue;
3090                                 }
3091                                 _mapping_update_ir_missing_cnt(sc, map_idx,
3092                                     element, wwid_table[i]);
3093                         } else if (element->ReasonCode ==
3094                             MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED) {
3095                                 map_idx = _mapping_get_mt_idx_from_handle(sc,
3096                                     le16toh(element->VolDevHandle));
3097                                 if (map_idx == MPR_MAPTABLE_BAD_IDX) {
3098                                         mpr_dprint(sc, MPR_MAPPING,"%s: Failed "
3099                                             "to remove volume with handle "
3100                                             "0x%04x because it has already "
3101                                             "been removed.\n", __func__,
3102                                             le16toh(element->VolDevHandle));
3103                                         continue;
3104                                 }
3105                                 mt_entry = &sc->mapping_table[map_idx];
3106                                 _mapping_update_ir_missing_cnt(sc, map_idx,
3107                                     element, mt_entry->physical_id);
3108                         }
3109                 }
3110         }
3111
3112 out:
3113         _mapping_flush_dpm_pages(sc);
3114         free(wwid_table, M_MPR);
3115         if (sc->pending_map_events)
3116                 sc->pending_map_events--;
3117 }