2 * Copyright (c) 2017 Broadcom. All rights reserved.
3 * The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
15 * 3. Neither the name of the copyright holder nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
35 #include "ocs_utils.h"
38 #include <sys/sysctl.h>
39 #include <sys/ioccom.h>
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/linker.h>
43 #include <sys/firmware.h>
45 static d_open_t ocs_open;
46 static d_close_t ocs_close;
47 static d_ioctl_t ocs_ioctl;
49 static struct cdevsw ocs_cdevsw = {
50 .d_version = D_VERSION,
58 ocs_firmware_write(ocs_t *ocs, const uint8_t *buf, size_t buf_len, uint8_t *change_status);
61 ocs_open(struct cdev *cdev, int flags, int fmt, struct thread *td)
64 struct ocs_softc *ocs = cdev->si_drv1;
66 device_printf(ocs->dev, "%s\n", __func__);
72 ocs_close(struct cdev *cdev, int flag, int fmt, struct thread *td)
75 struct ocs_softc *ocs = cdev->si_drv1;
77 device_printf(ocs->dev, "%s\n", __func__);
83 __ocs_ioctl_mbox_cb(ocs_hw_t *hw, int32_t status, uint8_t *mqe, void *arg)
85 struct ocs_softc *ocs = arg;
87 /* wait for the ioctl to sleep before calling wakeup */
88 mtx_lock(&ocs->dbg_lock);
90 mtx_unlock(&ocs->dbg_lock);
98 ocs_process_sli_config (ocs_t *ocs, ocs_ioctl_elxu_mbox_t *mcmd, ocs_dma_t *dma){
99 sli4_cmd_sli_config_t *sli_config = (sli4_cmd_sli_config_t *)mcmd->payload;
101 if (sli_config->emb) {
102 sli4_req_hdr_t *req = (sli4_req_hdr_t *)sli_config->payload.embed;
104 switch (req->opcode) {
105 case SLI4_OPC_COMMON_READ_OBJECT:
106 if (mcmd->out_bytes) {
107 sli4_req_common_read_object_t *rdobj =
108 (sli4_req_common_read_object_t *)sli_config->payload.embed;
110 if (ocs_dma_alloc(ocs, dma, mcmd->out_bytes, 4096)) {
111 device_printf(ocs->dev, "%s: COMMON_READ_OBJECT - %lld allocation failed\n",
112 __func__, (unsigned long long)mcmd->out_bytes);
116 memset(dma->virt, 0, mcmd->out_bytes);
118 rdobj->host_buffer_descriptor[0].bde_type = SLI4_BDE_TYPE_BDE_64;
119 rdobj->host_buffer_descriptor[0].buffer_length = mcmd->out_bytes;
120 rdobj->host_buffer_descriptor[0].u.data.buffer_address_low = ocs_addr32_lo(dma->phys);
121 rdobj->host_buffer_descriptor[0].u.data.buffer_address_high = ocs_addr32_hi(dma->phys);
124 case SLI4_OPC_COMMON_WRITE_OBJECT:
126 sli4_req_common_write_object_t *wrobj =
127 (sli4_req_common_write_object_t *)sli_config->payload.embed;
129 if (ocs_dma_alloc(ocs, dma, wrobj->desired_write_length, 4096)) {
130 device_printf(ocs->dev, "%s: COMMON_WRITE_OBJECT - %d allocation failed\n",
131 __func__, wrobj->desired_write_length);
134 /* setup the descriptor */
135 wrobj->host_buffer_descriptor[0].bde_type = SLI4_BDE_TYPE_BDE_64;
136 wrobj->host_buffer_descriptor[0].buffer_length = wrobj->desired_write_length;
137 wrobj->host_buffer_descriptor[0].u.data.buffer_address_low = ocs_addr32_lo(dma->phys);
138 wrobj->host_buffer_descriptor[0].u.data.buffer_address_high = ocs_addr32_hi(dma->phys);
140 /* copy the data into the DMA buffer */
141 copyin((void *)(uintptr_t)mcmd->in_addr, dma->virt, mcmd->in_bytes);
144 case SLI4_OPC_COMMON_DELETE_OBJECT:
146 case SLI4_OPC_COMMON_READ_OBJECT_LIST:
147 if (mcmd->out_bytes) {
148 sli4_req_common_read_object_list_t *rdobj =
149 (sli4_req_common_read_object_list_t *)sli_config->payload.embed;
151 if (ocs_dma_alloc(ocs, dma, mcmd->out_bytes, 4096)) {
152 device_printf(ocs->dev, "%s: COMMON_READ_OBJECT_LIST - %lld allocation failed\n",
153 __func__,(unsigned long long) mcmd->out_bytes);
157 memset(dma->virt, 0, mcmd->out_bytes);
159 rdobj->host_buffer_descriptor[0].bde_type = SLI4_BDE_TYPE_BDE_64;
160 rdobj->host_buffer_descriptor[0].buffer_length = mcmd->out_bytes;
161 rdobj->host_buffer_descriptor[0].u.data.buffer_address_low = ocs_addr32_lo(dma->phys);
162 rdobj->host_buffer_descriptor[0].u.data.buffer_address_high = ocs_addr32_hi(dma->phys);
165 case SLI4_OPC_COMMON_READ_TRANSCEIVER_DATA:
168 device_printf(ocs->dev, "%s: in=%p (%lld) out=%p (%lld)\n", __func__,
169 (void *)(uintptr_t)mcmd->in_addr, (unsigned long long)mcmd->in_bytes,
170 (void *)(uintptr_t)mcmd->out_addr, (unsigned long long)mcmd->out_bytes);
171 device_printf(ocs->dev, "%s: unknown (opc=%#x)\n", __func__,
173 hexdump(mcmd, mcmd->size, NULL, 0);
177 uint32_t max_bytes = max(mcmd->in_bytes, mcmd->out_bytes);
178 if (ocs_dma_alloc(ocs, dma, max_bytes, 4096)) {
179 device_printf(ocs->dev, "%s: non-embedded - %u allocation failed\n",
180 __func__, max_bytes);
184 copyin((void *)(uintptr_t)mcmd->in_addr, dma->virt, mcmd->in_bytes);
186 sli_config->payload.mem.address_low = ocs_addr32_lo(dma->phys);
187 sli_config->payload.mem.address_high = ocs_addr32_hi(dma->phys);
188 sli_config->payload.mem.length = max_bytes;
195 ocs_process_mbx_ioctl(ocs_t *ocs, ocs_ioctl_elxu_mbox_t *mcmd)
197 ocs_dma_t dma = { 0 };
199 if ((ELXU_BSD_MAGIC != mcmd->magic) ||
200 (sizeof(ocs_ioctl_elxu_mbox_t) != mcmd->size)) {
201 device_printf(ocs->dev, "%s: malformed command m=%08x s=%08x\n",
202 __func__, mcmd->magic, mcmd->size);
206 switch(((sli4_mbox_command_header_t *)mcmd->payload)->command) {
207 case SLI4_MBOX_COMMAND_SLI_CONFIG:
208 if (ENXIO == ocs_process_sli_config(ocs, mcmd, &dma))
212 case SLI4_MBOX_COMMAND_READ_REV:
213 case SLI4_MBOX_COMMAND_READ_STATUS:
214 case SLI4_MBOX_COMMAND_READ_LNK_STAT:
218 device_printf(ocs->dev, "command %d\n",((sli4_mbox_command_header_t *)mcmd->payload)->command);
219 device_printf(ocs->dev, "%s, command not support\n", __func__);
225 * The dbg_lock usage here insures the command completion code
226 * (__ocs_ioctl_mbox_cb), which calls wakeup(), does not run until
227 * after first calling msleep()
229 * 1. ioctl grabs dbg_lock
230 * 2. ioctl issues command
231 * if the command completes before msleep(), the
232 * command completion code (__ocs_ioctl_mbox_cb) will spin
233 * on dbg_lock before calling wakeup()
234 * 3. ioctl calls msleep which releases dbg_lock before sleeping
235 * and reacquires it before waking
236 * 4. command completion handler acquires the dbg_lock, immediately
237 * releases it, and calls wakeup
238 * 5. msleep returns, re-acquiring the lock
239 * 6. ioctl code releases the lock
241 mtx_lock(&ocs->dbg_lock);
242 if (ocs_hw_command(&ocs->hw, mcmd->payload, OCS_CMD_NOWAIT,
243 __ocs_ioctl_mbox_cb, ocs)) {
244 device_printf(ocs->dev, "%s: command- %x failed\n", __func__,
245 ((sli4_mbox_command_header_t *)mcmd->payload)->command);
247 msleep(ocs, &ocs->dbg_lock, 0, "ocsmbx", 0);
248 mtx_unlock(&ocs->dbg_lock);
250 if( SLI4_MBOX_COMMAND_SLI_CONFIG == ((sli4_mbox_command_header_t *)mcmd->payload)->command
251 && mcmd->out_bytes && dma.virt) {
252 copyout(dma.virt, (void *)(uintptr_t)mcmd->out_addr, mcmd->out_bytes);
256 ocs_dma_free(ocs, &dma);
262 * @brief perform requested Elx CoreDump helper function
264 * The Elx CoreDump facility used for BE3 diagnostics uses the OCS_IOCTL_CMD_ECD_HELPER
265 * ioctl function to execute requested "help" functions
267 * @param ocs pointer to ocs structure
268 * @param req pointer to helper function request
270 * @return returns 0 for success, a negative error code value for failure.
274 ocs_process_ecd_helper (ocs_t *ocs, ocs_ioctl_ecd_helper_t *req)
281 /* Check the BAR read/write commands for valid bar */
283 case OCS_ECD_HELPER_BAR_READ8:
284 case OCS_ECD_HELPER_BAR_READ16:
285 case OCS_ECD_HELPER_BAR_READ32:
286 case OCS_ECD_HELPER_BAR_WRITE8:
287 case OCS_ECD_HELPER_BAR_WRITE16:
288 case OCS_ECD_HELPER_BAR_WRITE32:
289 if (req->bar >= PCI_MAX_BAR) {
290 device_printf(ocs->dev, "Error: bar %d out of range\n", req->bar);
293 if (ocs->reg[req->bar].res == NULL) {
294 device_printf(ocs->dev, "Error: bar %d not defined\n", req->bar);
303 case OCS_ECD_HELPER_CFG_READ8:
304 v8 = ocs_config_read8(ocs, req->offset);
307 case OCS_ECD_HELPER_CFG_READ16:
308 v16 = ocs_config_read16(ocs, req->offset);
311 case OCS_ECD_HELPER_CFG_READ32:
312 v32 = ocs_config_read32(ocs, req->offset);
315 case OCS_ECD_HELPER_CFG_WRITE8:
316 ocs_config_write8(ocs, req->offset, req->data);
318 case OCS_ECD_HELPER_CFG_WRITE16:
319 ocs_config_write16(ocs, req->offset, req->data);
321 case OCS_ECD_HELPER_CFG_WRITE32:
322 ocs_config_write32(ocs, req->offset, req->data);
324 case OCS_ECD_HELPER_BAR_READ8:
325 req->data = ocs_reg_read8(ocs, req->bar, req->offset);
327 case OCS_ECD_HELPER_BAR_READ16:
328 req->data = ocs_reg_read16(ocs, req->bar, req->offset);
330 case OCS_ECD_HELPER_BAR_READ32:
331 req->data = ocs_reg_read32(ocs, req->bar, req->offset);
333 case OCS_ECD_HELPER_BAR_WRITE8:
334 ocs_reg_write8(ocs, req->bar, req->offset, req->data);
336 case OCS_ECD_HELPER_BAR_WRITE16:
337 ocs_reg_write16(ocs, req->bar, req->offset, req->data);
339 case OCS_ECD_HELPER_BAR_WRITE32:
340 ocs_reg_write32(ocs, req->bar, req->offset, req->data);
343 device_printf(ocs->dev, "Invalid helper command=%d\n", req->cmd);
351 ocs_ioctl(struct cdev *cdev, u_long cmd, caddr_t addr, int flag, struct thread *td)
354 struct ocs_softc *ocs = cdev->si_drv1;
355 device_t dev = ocs->dev;
358 case OCS_IOCTL_CMD_ELXU_MBOX: {
359 /* "copyin" done by kernel; thus, just dereference addr */
360 ocs_ioctl_elxu_mbox_t *mcmd = (void *)addr;
361 status = ocs_process_mbx_ioctl(ocs, mcmd);
364 case OCS_IOCTL_CMD_ECD_HELPER: {
365 /* "copyin" done by kernel; thus, just dereference addr */
366 ocs_ioctl_ecd_helper_t *req = (void *)addr;
367 status = ocs_process_ecd_helper(ocs, req);
371 case OCS_IOCTL_CMD_VPORT: {
373 ocs_ioctl_vport_t *req = (ocs_ioctl_vport_t*) addr;
374 ocs_domain_t *domain;
376 domain = ocs_domain_get_instance(ocs, req->domain_index);
377 if (domain == NULL) {
378 device_printf(ocs->dev, "domain [%d] nod found\n",
383 if (req->req_create) {
384 rc = ocs_sport_vport_new(domain, req->wwpn, req->wwnn,
385 UINT32_MAX, req->enable_ini,
386 req->enable_tgt, NULL, NULL, TRUE);
388 rc = ocs_sport_vport_del(ocs, domain, req->wwpn, req->wwnn);
394 case OCS_IOCTL_CMD_GET_DDUMP: {
395 ocs_ioctl_ddump_t *req = (ocs_ioctl_ddump_t*) addr;
396 ocs_textbuf_t textbuf;
399 /* Build a text buffer */
400 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
401 device_printf(ocs->dev, "Error: ocs_textbuf_alloc failed\n");
405 switch (req->args.action) {
406 case OCS_IOCTL_DDUMP_GET:
407 case OCS_IOCTL_DDUMP_GET_SAVED: {
412 ocs_textbuf_t *ptbuf = NULL;
415 if (req->args.action == OCS_IOCTL_DDUMP_GET_SAVED) {
416 if (ocs_textbuf_initialized(&ocs->ddump_saved)) {
417 ptbuf = &ocs->ddump_saved;
420 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
421 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
425 /* translate IOCTL ddump flags to ddump flags */
426 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_WQES) {
427 flags |= OCS_DDUMP_FLAGS_WQES;
429 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_CQES) {
430 flags |= OCS_DDUMP_FLAGS_CQES;
432 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_MQES) {
433 flags |= OCS_DDUMP_FLAGS_MQES;
435 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_RQES) {
436 flags |= OCS_DDUMP_FLAGS_RQES;
438 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_EQES) {
439 flags |= OCS_DDUMP_FLAGS_EQES;
442 /* Try 3 times to get the dump */
444 if (ocs_ddump(ocs, &textbuf, flags, req->args.q_entries) != 0) {
445 ocs_textbuf_reset(&textbuf);
454 ocs_log_test(ocs, "ocs_ddump failed\n");
461 /* Process each textbuf segment */
462 remaining = req->user_buffer_len;
463 for (idx = 0; remaining; idx++) {
464 n = ocs_textbuf_ext_get_written(ptbuf, idx);
468 if ((uint32_t)n >= remaining) {
469 n = (int32_t)remaining;
471 if (ocs_copy_to_user(req->user_buffer + written,
472 ocs_textbuf_ext_get_buffer(ptbuf, idx), n)) {
473 ocs_log_test(ocs, "Error: (%d) ocs_copy_to_user failed\n", __LINE__);
476 remaining -= (uint32_t)n;
479 req->bytes_written = written;
480 if (ptbuf == &textbuf) {
481 ocs_textbuf_free(ocs, &textbuf);
486 case OCS_IOCTL_DDUMP_CLR_SAVED:
487 ocs_clear_saved_ddump(ocs);
490 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
495 case OCS_IOCTL_CMD_DRIVER_INFO: {
496 ocs_ioctl_driver_info_t *req = (ocs_ioctl_driver_info_t*)addr;
498 ocs_memset(req, 0, sizeof(*req));
500 req->pci_vendor = ocs->pci_vendor;
501 req->pci_device = ocs->pci_device;
502 ocs_strncpy(req->businfo, ocs->businfo, sizeof(req->businfo));
504 req->sli_intf = ocs_config_read32(ocs, SLI4_INTF_REG);
505 ocs_strncpy(req->desc, device_get_desc(dev), sizeof(req->desc));
506 ocs_strncpy(req->fw_rev, ocs->fwrev, sizeof(req->fw_rev));
507 if (ocs->domain && ocs->domain->sport) {
508 *((uint64_t*)req->hw_addr.fc.wwnn) = ocs_htobe64(ocs->domain->sport->wwnn);
509 *((uint64_t*)req->hw_addr.fc.wwpn) = ocs_htobe64(ocs->domain->sport->wwpn);
511 ocs_strncpy(req->serialnum, ocs->serialnum, sizeof(req->serialnum));
515 case OCS_IOCTL_CMD_MGMT_LIST: {
516 ocs_ioctl_mgmt_buffer_t* req = (ocs_ioctl_mgmt_buffer_t *)addr;
517 ocs_textbuf_t textbuf;
519 /* Build a text buffer */
520 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
521 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
525 ocs_mgmt_get_list(ocs, &textbuf);
527 if (ocs_textbuf_get_written(&textbuf)) {
528 if (ocs_copy_to_user(req->user_buffer,
529 ocs_textbuf_get_buffer(&textbuf),
530 ocs_textbuf_get_written(&textbuf))) {
531 ocs_log_test(ocs, "Error: (%d) ocs_copy_to_user failed\n", __LINE__);
534 req->bytes_written = ocs_textbuf_get_written(&textbuf);
536 ocs_textbuf_free(ocs, &textbuf);
541 case OCS_IOCTL_CMD_MGMT_GET_ALL: {
542 ocs_ioctl_mgmt_buffer_t* req = (ocs_ioctl_mgmt_buffer_t *)addr;
543 ocs_textbuf_t textbuf;
548 /* Build a text buffer */
549 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
550 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
554 ocs_mgmt_get_all(ocs, &textbuf);
556 for (idx = 0; (n = ocs_textbuf_ext_get_written(&textbuf, idx)) > 0; idx++) {
557 if(ocs_copy_to_user(req->user_buffer + copied,
558 ocs_textbuf_ext_get_buffer(&textbuf, idx),
559 ocs_textbuf_ext_get_written(&textbuf, idx))) {
560 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
564 req->bytes_written = copied;
566 ocs_textbuf_free(ocs, &textbuf);
571 case OCS_IOCTL_CMD_MGMT_GET: {
572 ocs_ioctl_cmd_get_t* req = (ocs_ioctl_cmd_get_t*)addr;
573 ocs_textbuf_t textbuf;
574 char name[OCS_MGMT_MAX_NAME];
576 /* Copy the name value in from user space */
577 if (ocs_copy_from_user(name, req->name, OCS_MGMT_MAX_NAME)) {
578 ocs_log_test(ocs, "ocs_copy_from_user failed\n");
579 ocs_ioctl_free(ocs, req, sizeof(ocs_ioctl_cmd_get_t));
583 /* Build a text buffer */
584 if (ocs_textbuf_alloc(ocs, &textbuf, req->value_length)) {
585 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
589 ocs_mgmt_get(ocs, name, &textbuf);
591 if (ocs_textbuf_get_written(&textbuf)) {
592 if (ocs_copy_to_user(req->value,
593 ocs_textbuf_get_buffer(&textbuf),
594 ocs_textbuf_get_written(&textbuf))) {
595 ocs_log_test(ocs, "Error: (%d) ocs_copy_to_user failed\n", __LINE__);
598 req->value_length = ocs_textbuf_get_written(&textbuf);
600 ocs_textbuf_free(ocs, &textbuf);
605 case OCS_IOCTL_CMD_MGMT_SET: {
606 char name[OCS_MGMT_MAX_NAME];
607 char value[OCS_MGMT_MAX_VALUE];
608 ocs_ioctl_cmd_set_t* req = (ocs_ioctl_cmd_set_t*)addr;
610 // Copy the name in from user space
611 if (ocs_copy_from_user(name, req->name, OCS_MGMT_MAX_NAME)) {
612 ocs_log_test(ocs, "Error: copy from user failed\n");
613 ocs_ioctl_free(ocs, req, sizeof(*req));
617 // Copy the value in from user space
618 if (ocs_copy_from_user(value, req->value, OCS_MGMT_MAX_VALUE)) {
619 ocs_log_test(ocs, "Error: copy from user failed\n");
620 ocs_ioctl_free(ocs, req, sizeof(*req));
624 req->result = ocs_mgmt_set(ocs, req->name, req->value);
629 case OCS_IOCTL_CMD_MGMT_EXEC: {
630 ocs_ioctl_action_t* req = (ocs_ioctl_action_t*) addr;
631 char action_name[OCS_MGMT_MAX_NAME];
633 if (ocs_copy_from_user(action_name, req->name, sizeof(action_name))) {
634 ocs_log_test(ocs, "Error: copy req.name from user failed\n");
635 ocs_ioctl_free(ocs, req, sizeof(*req));
639 req->result = ocs_mgmt_exec(ocs, action_name, req->arg_in, req->arg_in_length,
640 req->arg_out, req->arg_out_length);
646 ocs_log_test(ocs, "Error: unknown cmd %#lx\n", cmd);
654 ocs_fw_write_cb(int32_t status, uint32_t actual_write_length,
655 uint32_t change_status, void *arg)
657 ocs_mgmt_fw_write_result_t *result = arg;
659 result->status = status;
660 result->actual_xfer = actual_write_length;
661 result->change_status = change_status;
663 ocs_sem_v(&(result->semaphore));
667 ocs_firmware_write(ocs_t *ocs, const uint8_t *buf, size_t buf_len,
668 uint8_t *change_status)
676 ocs_mgmt_fw_write_result_t result;
678 ocs_sem_init(&(result.semaphore), 0, "fw_write");
680 bytes_left = buf_len;
683 if (ocs_dma_alloc(ocs, &dma, FW_WRITE_BUFSIZE, 4096)) {
684 ocs_log_err(ocs, "ocs_firmware_write: malloc failed\n");
688 while (bytes_left > 0) {
689 if (bytes_left > FW_WRITE_BUFSIZE) {
690 xfer_size = FW_WRITE_BUFSIZE;
692 xfer_size = bytes_left;
695 ocs_memcpy(dma.virt, buf + offset, xfer_size);
697 if (bytes_left == xfer_size) {
701 ocs_hw_firmware_write(&ocs->hw, &dma, xfer_size, offset,
702 last, ocs_fw_write_cb, &result);
704 if (ocs_sem_p(&(result.semaphore), OCS_SEM_FOREVER) != 0) {
709 if (result.actual_xfer == 0 || result.status != 0) {
715 *change_status = result.change_status;
718 bytes_left -= result.actual_xfer;
719 offset += result.actual_xfer;
722 ocs_dma_free(ocs, &dma);
727 ocs_sys_fwupgrade(SYSCTL_HANDLER_ARGS)
729 char file_name[256] = {0};
730 char fw_change_status;
732 ocs_t *ocs = (ocs_t *)arg1;
733 const struct firmware *fw;
734 const struct ocs_hw_grp_hdr *fw_image;
736 rc = sysctl_handle_string(oidp, file_name, sizeof(file_name), req);
737 if (rc || !req->newptr)
740 fw = firmware_get(file_name);
742 device_printf(ocs->dev, "Unable to get Firmware. "
743 "Make sure %s is copied to /boot/modules\n", file_name);
747 fw_image = (const struct ocs_hw_grp_hdr *)fw->data;
749 /* Check if firmware provided is compatible with this particular
751 if ((ocs_be32toh(fw_image->magic_number) != OCS_HW_OBJECT_G5) &&
752 (ocs_be32toh(fw_image->magic_number) != OCS_HW_OBJECT_G6)) {
753 device_printf(ocs->dev,
754 "Invalid FW image found Magic: 0x%x Size: %zu \n",
755 ocs_be32toh(fw_image->magic_number), fw->datasize);
760 if (!strncmp(ocs->fw_version, fw_image->revision,
761 strnlen(fw_image->revision, 16))) {
762 device_printf(ocs->dev, "No update req. "
763 "Firmware is already up to date. \n");
768 device_printf(ocs->dev, "Upgrading Firmware from %s to %s \n",
769 ocs->fw_version, fw_image->revision);
771 rc = ocs_firmware_write(ocs, fw->data, fw->datasize, &fw_change_status);
773 ocs_log_err(ocs, "Firmware update failed with status = %d\n", rc);
775 ocs_log_info(ocs, "Firmware updated successfully\n");
776 switch (fw_change_status) {
778 device_printf(ocs->dev,
779 "No reset needed, new firmware is active.\n");
782 device_printf(ocs->dev,
783 "A physical device reset (host reboot) is "
784 "needed to activate the new firmware\n");
788 device_printf(ocs->dev,
789 "firmware is resetting to activate the new "
790 "firmware, Host reboot is needed \n");
794 "Unexected value change_status: %d\n",
801 /* Release Firmware*/
802 firmware_put(fw, FIRMWARE_UNLOAD);
809 ocs_sysctl_wwnn(SYSCTL_HANDLER_ARGS)
812 ocs_t *ocs = oidp->oid_arg1;
815 uint64_t *wwnn = NULL;
816 ocs_xport_t *xport = ocs->xport;
818 if (xport->req_wwnn) {
819 wwnn = &xport->req_wwnn;
820 memset(old, 0, sizeof(old));
821 snprintf(old, sizeof(old), "0x%llx" , (unsigned long long) *wwnn);
824 wwnn = ocs_hw_get_ptr(&ocs->hw, OCS_HW_WWN_NODE);
826 memset(old, 0, sizeof(old));
827 snprintf(old, sizeof(old), "0x%llx" , (unsigned long long) ocs_htobe64(*wwnn));
832 return (sysctl_handle_string(oidp, old, sizeof(old), req));
835 /*Configure port wwn*/
836 rc = sysctl_handle_string(oidp, new, sizeof(new), req);
840 if (strncmp(old, new, strlen(old)) == 0) {
844 return (set_req_wwnn(ocs, NULL, new));
848 ocs_sysctl_wwpn(SYSCTL_HANDLER_ARGS)
851 ocs_t *ocs = oidp->oid_arg1;
854 uint64_t *wwpn = NULL;
855 ocs_xport_t *xport = ocs->xport;
857 if (xport->req_wwpn) {
858 wwpn = &xport->req_wwpn;
859 memset(old, 0, sizeof(old));
860 snprintf(old, sizeof(old), "0x%llx",(unsigned long long) *wwpn);
862 wwpn = ocs_hw_get_ptr(&ocs->hw, OCS_HW_WWN_PORT);
863 memset(old, 0, sizeof(old));
864 snprintf(old, sizeof(old), "0x%llx",(unsigned long long) ocs_htobe64(*wwpn));
869 return (sysctl_handle_string(oidp, old, sizeof(old), req));
872 /*Configure port wwn*/
873 rc = sysctl_handle_string(oidp, new, sizeof(new), req);
877 if (strncmp(old, new, strlen(old)) == 0) {
881 return (set_req_wwpn(ocs, NULL, new));
885 ocs_sysctl_current_topology(SYSCTL_HANDLER_ARGS)
887 ocs_t *ocs = oidp->oid_arg1;
890 ocs_hw_get(&ocs->hw, OCS_HW_TOPOLOGY, &value);
892 return (sysctl_handle_int(oidp, &value, 0, req));
896 ocs_sysctl_current_speed(SYSCTL_HANDLER_ARGS)
898 ocs_t *ocs = oidp->oid_arg1;
901 ocs_hw_get(&ocs->hw, OCS_HW_LINK_SPEED, &value);
903 return (sysctl_handle_int(oidp, &value, 0, req));
907 ocs_sysctl_config_topology(SYSCTL_HANDLER_ARGS)
910 ocs_t *ocs = oidp->oid_arg1;
915 ocs_hw_get(&ocs->hw, OCS_HW_CONFIG_TOPOLOGY, &old_value);
919 return (sysctl_handle_int(oidp, &old_value, 0, req));
922 /*Configure port wwn*/
923 rc = sysctl_handle_int(oidp, &new_value, 0, req);
927 if (new_value == old_value) {
931 snprintf(buf, sizeof(buf), "%d",new_value);
932 rc = set_configured_topology(ocs, NULL, buf);
937 ocs_sysctl_config_speed(SYSCTL_HANDLER_ARGS)
940 ocs_t *ocs = oidp->oid_arg1;
945 ocs_hw_get(&ocs->hw, OCS_HW_LINK_CONFIG_SPEED, &old_value);
949 return (sysctl_handle_int(oidp, &old_value, 0, req));
952 /*Configure port wwn*/
953 rc = sysctl_handle_int(oidp, &new_value, 0, req);
957 if (new_value == old_value) {
961 snprintf(buf, sizeof(buf), "%d",new_value);
962 rc = set_configured_speed(ocs, NULL,buf);
967 ocs_sysctl_fcid(SYSCTL_HANDLER_ARGS)
969 ocs_t *ocs = oidp->oid_arg1;
972 memset(buf, 0, sizeof(buf));
973 if (ocs->domain && ocs->domain->attached) {
974 snprintf(buf, sizeof(buf), "0x%06x",
975 ocs->domain->sport->fc_id);
978 return (sysctl_handle_string(oidp, buf, sizeof(buf), req));
982 ocs_sysctl_port_state(SYSCTL_HANDLER_ARGS)
987 ocs_xport_stats_t old;
988 ocs_t *ocs = (ocs_t *)arg1;
990 ocs_xport_status(ocs->xport, OCS_XPORT_CONFIG_PORT_STATUS, &old);
994 snprintf(new, sizeof(new), "%s",
995 (old.value == OCS_XPORT_PORT_OFFLINE) ?
996 "offline" : "online");
997 return (sysctl_handle_string(oidp, new, sizeof(new), req));
1000 /*Configure port state*/
1001 rc = sysctl_handle_string(oidp, new, sizeof(new), req);
1005 if (ocs_strcasecmp(new, "offline") == 0) {
1006 if (old.value == OCS_XPORT_PORT_OFFLINE) {
1009 ocs_log_debug(ocs, "Setting port to %s\n", new);
1010 rc = ocs_xport_control(ocs->xport, OCS_XPORT_PORT_OFFLINE);
1012 ocs_log_err(ocs, "Setting port to offline failed\n");
1014 } else if (ocs_strcasecmp(new, "online") == 0) {
1015 if (old.value == OCS_XPORT_PORT_ONLINE) {
1018 ocs_log_debug(ocs, "Setting port to %s\n", new);
1019 rc = ocs_xport_control(ocs->xport, OCS_XPORT_PORT_ONLINE);
1021 ocs_log_err(ocs, "Setting port to online failed\n");
1024 ocs_log_err(ocs, "Unsupported link state %s\n", new);
1033 ocs_sysctl_vport_wwpn(SYSCTL_HANDLER_ARGS)
1035 ocs_fcport *fcp = oidp->oid_arg1;
1038 memset(str_wwpn, 0, sizeof(str_wwpn));
1039 snprintf(str_wwpn, sizeof(str_wwpn), "0x%llx", (unsigned long long)fcp->vport->wwpn);
1041 return (sysctl_handle_string(oidp, str_wwpn, sizeof(str_wwpn), req));
1045 ocs_sysctl_vport_wwnn(SYSCTL_HANDLER_ARGS)
1047 ocs_fcport *fcp = oidp->oid_arg1;
1050 memset(str_wwnn, 0, sizeof(str_wwnn));
1051 snprintf(str_wwnn, sizeof(str_wwnn), "0x%llx", (unsigned long long)fcp->vport->wwnn);
1053 return (sysctl_handle_string(oidp, str_wwnn, sizeof(str_wwnn), req));
1057 * @brief Initialize sysctl
1059 * Initialize sysctl so elxsdkutil can query device information.
1061 * @param ocs pointer to ocs
1065 ocs_sysctl_init(ocs_t *ocs)
1067 struct sysctl_ctx_list *ctx = device_get_sysctl_ctx(ocs->dev);
1068 struct sysctl_oid *tree = device_get_sysctl_tree(ocs->dev);
1069 struct sysctl_oid *vtree;
1070 const char *str = NULL;
1072 uint32_t rev, if_type, family, i;
1073 ocs_fcport *fcp = NULL;
1075 SYSCTL_ADD_UINT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1076 "devid", CTLFLAG_RD, NULL,
1077 pci_get_devid(ocs->dev), "Device ID");
1079 memset(ocs->modeldesc, 0, sizeof(ocs->modeldesc));
1080 if (0 == pci_get_vpd_ident(ocs->dev, &str)) {
1081 snprintf(ocs->modeldesc, sizeof(ocs->modeldesc), "%s", str);
1083 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1084 "modeldesc", CTLFLAG_RD,
1086 0, "Model Description");
1088 memset(ocs->serialnum, 0, sizeof(ocs->serialnum));
1089 if (0 == pci_get_vpd_readonly(ocs->dev, "SN", &str)) {
1090 snprintf(ocs->serialnum, sizeof(ocs->serialnum), "%s", str);
1092 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1095 0, "Serial Number");
1097 ocs_hw_get(&ocs->hw, OCS_HW_SLI_REV, &rev);
1098 ocs_hw_get(&ocs->hw, OCS_HW_IF_TYPE, &if_type);
1099 ocs_hw_get(&ocs->hw, OCS_HW_SLI_FAMILY, &family);
1101 memset(ocs->fwrev, 0, sizeof(ocs->fwrev));
1102 snprintf(ocs->fwrev, sizeof(ocs->fwrev), "%s, sli-%d:%d:%x",
1103 (char *)ocs_hw_get_ptr(&ocs->hw, OCS_HW_FW_REV),
1104 rev, if_type, family);
1105 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1106 "fwrev", CTLFLAG_RD,
1108 0, "Firmware Revision");
1110 memset(ocs->sli_intf, 0, sizeof(ocs->sli_intf));
1111 snprintf(ocs->sli_intf, sizeof(ocs->sli_intf), "%08x",
1112 ocs_config_read32(ocs, SLI4_INTF_REG));
1113 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1114 "sli_intf", CTLFLAG_RD,
1116 0, "SLI Interface");
1118 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, "fw_upgrade",
1119 CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT, (void *)ocs, 0,
1120 ocs_sys_fwupgrade, "A", "Firmware grp file");
1122 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1123 "wwnn", CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1124 ocs, 0, ocs_sysctl_wwnn, "A",
1125 "World Wide Node Name, wwnn should be in the format 0x<XXXXXXXXXXXXXXXX>");
1127 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1128 "wwpn", CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1129 ocs, 0, ocs_sysctl_wwpn, "A",
1130 "World Wide Port Name, wwpn should be in the format 0x<XXXXXXXXXXXXXXXX>");
1132 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1133 "current_topology", CTLTYPE_UINT | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
1134 ocs, 0, ocs_sysctl_current_topology, "IU",
1135 "Current Topology, 1-NPort; 2-Loop; 3-None");
1137 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1138 "current_speed", CTLTYPE_UINT | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
1139 ocs, 0, ocs_sysctl_current_speed, "IU",
1142 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1143 "configured_topology", CTLTYPE_UINT | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1144 ocs, 0, ocs_sysctl_config_topology, "IU",
1145 "Configured Topology, 0-Auto; 1-NPort; 2-Loop");
1147 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1148 "configured_speed", CTLTYPE_UINT | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1149 ocs, 0, ocs_sysctl_config_speed, "IU",
1150 "Configured Speed, 0-Auto, 2000, 4000, 8000, 16000, 32000");
1152 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1153 "businfo", CTLFLAG_RD,
1157 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1158 "fcid", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
1159 ocs, 0, ocs_sysctl_fcid, "A", "Port FC ID");
1161 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1162 "port_state", CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1163 ocs, 0, ocs_sysctl_port_state, "A", "configured port state");
1165 for (i = 0; i < ocs->num_vports; i++) {
1166 fcp = FCPORT(ocs, i+1);
1168 memset(name, 0, sizeof(name));
1169 snprintf(name, sizeof(name), "vport%d", i);
1170 vtree = SYSCTL_ADD_NODE(ctx, SYSCTL_CHILDREN(tree),
1171 OID_AUTO, name, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
1174 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(vtree), OID_AUTO,
1175 "wwnn", CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1176 fcp, 0, ocs_sysctl_vport_wwnn, "A",
1177 "World Wide Node Name");
1179 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(vtree), OID_AUTO,
1180 "wwpn", CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1181 fcp, 0, ocs_sysctl_vport_wwpn, "A", "World Wide Port Name");
1187 * @brief Initialize the debug module
1189 * Parse device hints (similar to Linux module parameters) here. To use,
1191 * kenv hint.ocs.U.P=V
1192 * from the command line replacing U with the unit # (0,1,...),
1193 * P with the parameter name (debug_mask), and V with the value
1196 ocs_debug_attach(void *os)
1198 struct ocs_softc *ocs = os;
1200 char *resname = NULL;
1201 int32_t unit = INT32_MAX;
1202 uint32_t ocs_debug_mask = 0;
1204 resname = "debug_mask";
1205 if (0 == (error = resource_int_value(device_get_name(ocs->dev), device_get_unit(ocs->dev),
1206 resname, &ocs_debug_mask))) {
1207 device_printf(ocs->dev, "setting %s to %010x\n", resname, ocs_debug_mask);
1208 ocs_debug_enable(ocs_debug_mask);
1211 unit = device_get_unit(ocs->dev);
1212 ocs->cdev = make_dev(&ocs_cdevsw, unit, UID_ROOT, GID_OPERATOR, 0640,
1215 ocs->cdev->si_drv1 = ocs;
1218 /* initialize sysctl interface */
1219 ocs_sysctl_init(ocs);
1220 mtx_init(&ocs->dbg_lock, "ocs_dbg_lock", NULL, MTX_DEF);
1224 * @brief Free the debug module
1227 ocs_debug_detach(void *os)
1229 struct ocs_softc *ocs = os;
1231 mtx_destroy(&ocs->dbg_lock);
1234 ocs->cdev->si_drv1 = NULL;
1235 destroy_dev(ocs->cdev);