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){
100 sli4_cmd_sli_config_t *sli_config = (sli4_cmd_sli_config_t *)mcmd->payload;
102 if (sli_config->emb) {
103 sli4_req_hdr_t *req = (sli4_req_hdr_t *)sli_config->payload.embed;
105 switch (req->opcode) {
106 case SLI4_OPC_COMMON_READ_OBJECT:
107 if (mcmd->out_bytes) {
108 sli4_req_common_read_object_t *rdobj =
109 (sli4_req_common_read_object_t *)sli_config->payload.embed;
111 if (ocs_dma_alloc(ocs, dma, mcmd->out_bytes, 4096)) {
112 device_printf(ocs->dev, "%s: COMMON_READ_OBJECT - %lld allocation failed\n",
113 __func__, (unsigned long long)mcmd->out_bytes);
117 memset(dma->virt, 0, mcmd->out_bytes);
119 rdobj->host_buffer_descriptor[0].bde_type = SLI4_BDE_TYPE_BDE_64;
120 rdobj->host_buffer_descriptor[0].buffer_length = mcmd->out_bytes;
121 rdobj->host_buffer_descriptor[0].u.data.buffer_address_low = ocs_addr32_lo(dma->phys);
122 rdobj->host_buffer_descriptor[0].u.data.buffer_address_high = ocs_addr32_hi(dma->phys);
126 case SLI4_OPC_COMMON_WRITE_OBJECT:
128 sli4_req_common_write_object_t *wrobj =
129 (sli4_req_common_write_object_t *)sli_config->payload.embed;
131 if (ocs_dma_alloc(ocs, dma, wrobj->desired_write_length, 4096)) {
132 device_printf(ocs->dev, "%s: COMMON_WRITE_OBJECT - %d allocation failed\n",
133 __func__, wrobj->desired_write_length);
136 /* setup the descriptor */
137 wrobj->host_buffer_descriptor[0].bde_type = SLI4_BDE_TYPE_BDE_64;
138 wrobj->host_buffer_descriptor[0].buffer_length = wrobj->desired_write_length;
139 wrobj->host_buffer_descriptor[0].u.data.buffer_address_low = ocs_addr32_lo(dma->phys);
140 wrobj->host_buffer_descriptor[0].u.data.buffer_address_high = ocs_addr32_hi(dma->phys);
142 /* copy the data into the DMA buffer */
143 copyin((void *)(uintptr_t)mcmd->in_addr, dma->virt, mcmd->in_bytes);
146 case SLI4_OPC_COMMON_DELETE_OBJECT:
148 case SLI4_OPC_COMMON_READ_OBJECT_LIST:
149 if (mcmd->out_bytes) {
150 sli4_req_common_read_object_list_t *rdobj =
151 (sli4_req_common_read_object_list_t *)sli_config->payload.embed;
153 if (ocs_dma_alloc(ocs, dma, mcmd->out_bytes, 4096)) {
154 device_printf(ocs->dev, "%s: COMMON_READ_OBJECT_LIST - %lld allocation failed\n",
155 __func__,(unsigned long long) mcmd->out_bytes);
159 memset(dma->virt, 0, mcmd->out_bytes);
161 rdobj->host_buffer_descriptor[0].bde_type = SLI4_BDE_TYPE_BDE_64;
162 rdobj->host_buffer_descriptor[0].buffer_length = mcmd->out_bytes;
163 rdobj->host_buffer_descriptor[0].u.data.buffer_address_low = ocs_addr32_lo(dma->phys);
164 rdobj->host_buffer_descriptor[0].u.data.buffer_address_high = ocs_addr32_hi(dma->phys);
168 case SLI4_OPC_COMMON_READ_TRANSCEIVER_DATA:
171 device_printf(ocs->dev, "%s: in=%p (%lld) out=%p (%lld)\n", __func__,
172 (void *)(uintptr_t)mcmd->in_addr, (unsigned long long)mcmd->in_bytes,
173 (void *)(uintptr_t)mcmd->out_addr, (unsigned long long)mcmd->out_bytes);
174 device_printf(ocs->dev, "%s: unknown (opc=%#x)\n", __func__,
176 hexdump(mcmd, mcmd->size, NULL, 0);
180 uint32_t max_bytes = max(mcmd->in_bytes, mcmd->out_bytes);
181 if (ocs_dma_alloc(ocs, dma, max_bytes, 4096)) {
182 device_printf(ocs->dev, "%s: non-embedded - %u allocation failed\n",
183 __func__, max_bytes);
187 copyin((void *)(uintptr_t)mcmd->in_addr, dma->virt, mcmd->in_bytes);
189 sli_config->payload.mem.address_low = ocs_addr32_lo(dma->phys);
190 sli_config->payload.mem.address_high = ocs_addr32_hi(dma->phys);
191 sli_config->payload.mem.length = max_bytes;
198 ocs_process_mbx_ioctl(ocs_t *ocs, ocs_ioctl_elxu_mbox_t *mcmd)
200 ocs_dma_t dma = { 0 };
202 if ((ELXU_BSD_MAGIC != mcmd->magic) ||
203 (sizeof(ocs_ioctl_elxu_mbox_t) != mcmd->size)) {
204 device_printf(ocs->dev, "%s: malformed command m=%08x s=%08x\n",
205 __func__, mcmd->magic, mcmd->size);
209 switch(((sli4_mbox_command_header_t *)mcmd->payload)->command) {
210 case SLI4_MBOX_COMMAND_SLI_CONFIG:
211 if (ENXIO == ocs_process_sli_config(ocs, mcmd, &dma))
215 case SLI4_MBOX_COMMAND_READ_REV:
216 case SLI4_MBOX_COMMAND_READ_STATUS:
217 case SLI4_MBOX_COMMAND_READ_LNK_STAT:
221 device_printf(ocs->dev, "command %d\n",((sli4_mbox_command_header_t *)mcmd->payload)->command);
222 device_printf(ocs->dev, "%s, command not support\n", __func__);
229 * The dbg_lock usage here insures the command completion code
230 * (__ocs_ioctl_mbox_cb), which calls wakeup(), does not run until
231 * after first calling msleep()
233 * 1. ioctl grabs dbg_lock
234 * 2. ioctl issues command
235 * if the command completes before msleep(), the
236 * command completion code (__ocs_ioctl_mbox_cb) will spin
237 * on dbg_lock before calling wakeup()
238 * 3. ioctl calls msleep which releases dbg_lock before sleeping
239 * and reacquires it before waking
240 * 4. command completion handler acquires the dbg_lock, immediately
241 * releases it, and calls wakeup
242 * 5. msleep returns, re-acquiring the lock
243 * 6. ioctl code releases the lock
245 mtx_lock(&ocs->dbg_lock);
246 if (ocs_hw_command(&ocs->hw, mcmd->payload, OCS_CMD_NOWAIT,
247 __ocs_ioctl_mbox_cb, ocs)) {
249 device_printf(ocs->dev, "%s: command- %x failed\n", __func__,
250 ((sli4_mbox_command_header_t *)mcmd->payload)->command);
252 msleep(ocs, &ocs->dbg_lock, 0, "ocsmbx", 0);
253 mtx_unlock(&ocs->dbg_lock);
255 if( SLI4_MBOX_COMMAND_SLI_CONFIG == ((sli4_mbox_command_header_t *)mcmd->payload)->command
256 && mcmd->out_bytes && dma.virt) {
257 copyout(dma.virt, (void *)(uintptr_t)mcmd->out_addr, mcmd->out_bytes);
261 ocs_dma_free(ocs, &dma);
267 * @brief perform requested Elx CoreDump helper function
269 * The Elx CoreDump facility used for BE3 diagnostics uses the OCS_IOCTL_CMD_ECD_HELPER
270 * ioctl function to execute requested "help" functions
272 * @param ocs pointer to ocs structure
273 * @param req pointer to helper function request
275 * @return returns 0 for success, a negative error code value for failure.
279 ocs_process_ecd_helper (ocs_t *ocs, ocs_ioctl_ecd_helper_t *req)
287 /* Check the BAR read/write commands for valid bar */
289 case OCS_ECD_HELPER_BAR_READ8:
290 case OCS_ECD_HELPER_BAR_READ16:
291 case OCS_ECD_HELPER_BAR_READ32:
292 case OCS_ECD_HELPER_BAR_WRITE8:
293 case OCS_ECD_HELPER_BAR_WRITE16:
294 case OCS_ECD_HELPER_BAR_WRITE32:
295 if (req->bar >= PCI_MAX_BAR) {
296 device_printf(ocs->dev, "Error: bar %d out of range\n", req->bar);
299 if (ocs->reg[req->bar].res == NULL) {
300 device_printf(ocs->dev, "Error: bar %d not defined\n", req->bar);
309 case OCS_ECD_HELPER_CFG_READ8:
310 v8 = ocs_config_read8(ocs, req->offset);
313 case OCS_ECD_HELPER_CFG_READ16:
314 v16 = ocs_config_read16(ocs, req->offset);
317 case OCS_ECD_HELPER_CFG_READ32:
318 v32 = ocs_config_read32(ocs, req->offset);
321 case OCS_ECD_HELPER_CFG_WRITE8:
322 ocs_config_write8(ocs, req->offset, req->data);
324 case OCS_ECD_HELPER_CFG_WRITE16:
325 ocs_config_write16(ocs, req->offset, req->data);
327 case OCS_ECD_HELPER_CFG_WRITE32:
328 ocs_config_write32(ocs, req->offset, req->data);
330 case OCS_ECD_HELPER_BAR_READ8:
331 req->data = ocs_reg_read8(ocs, req->bar, req->offset);
333 case OCS_ECD_HELPER_BAR_READ16:
334 req->data = ocs_reg_read16(ocs, req->bar, req->offset);
336 case OCS_ECD_HELPER_BAR_READ32:
337 req->data = ocs_reg_read32(ocs, req->bar, req->offset);
339 case OCS_ECD_HELPER_BAR_WRITE8:
340 ocs_reg_write8(ocs, req->bar, req->offset, req->data);
342 case OCS_ECD_HELPER_BAR_WRITE16:
343 ocs_reg_write16(ocs, req->bar, req->offset, req->data);
345 case OCS_ECD_HELPER_BAR_WRITE32:
346 ocs_reg_write32(ocs, req->bar, req->offset, req->data);
349 device_printf(ocs->dev, "Invalid helper command=%d\n", req->cmd);
357 ocs_ioctl(struct cdev *cdev, u_long cmd, caddr_t addr, int flag, struct thread *td)
360 struct ocs_softc *ocs = cdev->si_drv1;
361 device_t dev = ocs->dev;
364 case OCS_IOCTL_CMD_ELXU_MBOX: {
365 /* "copyin" done by kernel; thus, just dereference addr */
366 ocs_ioctl_elxu_mbox_t *mcmd = (void *)addr;
367 status = ocs_process_mbx_ioctl(ocs, mcmd);
370 case OCS_IOCTL_CMD_ECD_HELPER: {
371 /* "copyin" done by kernel; thus, just dereference addr */
372 ocs_ioctl_ecd_helper_t *req = (void *)addr;
373 status = ocs_process_ecd_helper(ocs, req);
377 case OCS_IOCTL_CMD_VPORT: {
379 ocs_ioctl_vport_t *req = (ocs_ioctl_vport_t*) addr;
380 ocs_domain_t *domain;
382 domain = ocs_domain_get_instance(ocs, req->domain_index);
383 if (domain == NULL) {
384 device_printf(ocs->dev, "domain [%d] nod found\n",
389 if (req->req_create) {
390 rc = ocs_sport_vport_new(domain, req->wwpn, req->wwnn,
391 UINT32_MAX, req->enable_ini,
392 req->enable_tgt, NULL, NULL, TRUE);
394 rc = ocs_sport_vport_del(ocs, domain, req->wwpn, req->wwnn);
400 case OCS_IOCTL_CMD_GET_DDUMP: {
401 ocs_ioctl_ddump_t *req = (ocs_ioctl_ddump_t*) addr;
402 ocs_textbuf_t textbuf;
405 /* Build a text buffer */
406 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
407 device_printf(ocs->dev, "Error: ocs_textbuf_alloc failed\n");
411 switch (req->args.action) {
412 case OCS_IOCTL_DDUMP_GET:
413 case OCS_IOCTL_DDUMP_GET_SAVED: {
418 ocs_textbuf_t *ptbuf = NULL;
421 if (req->args.action == OCS_IOCTL_DDUMP_GET_SAVED) {
422 if (ocs_textbuf_initialized(&ocs->ddump_saved)) {
423 ptbuf = &ocs->ddump_saved;
426 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
427 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
431 /* translate IOCTL ddump flags to ddump flags */
432 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_WQES) {
433 flags |= OCS_DDUMP_FLAGS_WQES;
435 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_CQES) {
436 flags |= OCS_DDUMP_FLAGS_CQES;
438 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_MQES) {
439 flags |= OCS_DDUMP_FLAGS_MQES;
441 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_RQES) {
442 flags |= OCS_DDUMP_FLAGS_RQES;
444 if (req->args.flags & OCS_IOCTL_DDUMP_FLAGS_EQES) {
445 flags |= OCS_DDUMP_FLAGS_EQES;
448 /* Try 3 times to get the dump */
450 if (ocs_ddump(ocs, &textbuf, flags, req->args.q_entries) != 0) {
451 ocs_textbuf_reset(&textbuf);
460 ocs_log_test(ocs, "ocs_ddump failed\n");
468 /* Process each textbuf segment */
469 remaining = req->user_buffer_len;
470 for (idx = 0; remaining; idx++) {
471 n = ocs_textbuf_ext_get_written(ptbuf, idx);
475 if ((uint32_t)n >= remaining) {
476 n = (int32_t)remaining;
478 if (ocs_copy_to_user(req->user_buffer + written,
479 ocs_textbuf_ext_get_buffer(ptbuf, idx), n)) {
480 ocs_log_test(ocs, "Error: (%d) ocs_copy_to_user failed\n", __LINE__);
483 remaining -= (uint32_t)n;
486 req->bytes_written = written;
487 if (ptbuf == &textbuf) {
488 ocs_textbuf_free(ocs, &textbuf);
493 case OCS_IOCTL_DDUMP_CLR_SAVED:
494 ocs_clear_saved_ddump(ocs);
497 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
502 case OCS_IOCTL_CMD_DRIVER_INFO: {
503 ocs_ioctl_driver_info_t *req = (ocs_ioctl_driver_info_t*)addr;
505 ocs_memset(req, 0, sizeof(*req));
507 req->pci_vendor = ocs->pci_vendor;
508 req->pci_device = ocs->pci_device;
509 ocs_strncpy(req->businfo, ocs->businfo, sizeof(req->businfo));
511 req->sli_intf = ocs_config_read32(ocs, SLI4_INTF_REG);
512 ocs_strncpy(req->desc, device_get_desc(dev), sizeof(req->desc));
513 ocs_strncpy(req->fw_rev, ocs->fwrev, sizeof(req->fw_rev));
514 if (ocs->domain && ocs->domain->sport) {
515 *((uint64_t*)req->hw_addr.fc.wwnn) = ocs_htobe64(ocs->domain->sport->wwnn);
516 *((uint64_t*)req->hw_addr.fc.wwpn) = ocs_htobe64(ocs->domain->sport->wwpn);
518 ocs_strncpy(req->serialnum, ocs->serialnum, sizeof(req->serialnum));
522 case OCS_IOCTL_CMD_MGMT_LIST: {
523 ocs_ioctl_mgmt_buffer_t* req = (ocs_ioctl_mgmt_buffer_t *)addr;
524 ocs_textbuf_t textbuf;
526 /* Build a text buffer */
527 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
528 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
532 ocs_mgmt_get_list(ocs, &textbuf);
534 if (ocs_textbuf_get_written(&textbuf)) {
535 if (ocs_copy_to_user(req->user_buffer,
536 ocs_textbuf_get_buffer(&textbuf),
537 ocs_textbuf_get_written(&textbuf))) {
538 ocs_log_test(ocs, "Error: (%d) ocs_copy_to_user failed\n", __LINE__);
541 req->bytes_written = ocs_textbuf_get_written(&textbuf);
543 ocs_textbuf_free(ocs, &textbuf);
549 case OCS_IOCTL_CMD_MGMT_GET_ALL: {
550 ocs_ioctl_mgmt_buffer_t* req = (ocs_ioctl_mgmt_buffer_t *)addr;
551 ocs_textbuf_t textbuf;
556 /* Build a text buffer */
557 if (ocs_textbuf_alloc(ocs, &textbuf, req->user_buffer_len)) {
558 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
562 ocs_mgmt_get_all(ocs, &textbuf);
564 for (idx = 0; (n = ocs_textbuf_ext_get_written(&textbuf, idx)) > 0; idx++) {
565 if(ocs_copy_to_user(req->user_buffer + copied,
566 ocs_textbuf_ext_get_buffer(&textbuf, idx),
567 ocs_textbuf_ext_get_written(&textbuf, idx))) {
569 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
573 req->bytes_written = copied;
575 ocs_textbuf_free(ocs, &textbuf);
580 case OCS_IOCTL_CMD_MGMT_GET: {
581 ocs_ioctl_cmd_get_t* req = (ocs_ioctl_cmd_get_t*)addr;
582 ocs_textbuf_t textbuf;
583 char name[OCS_MGMT_MAX_NAME];
585 /* Copy the name value in from user space */
586 if (ocs_copy_from_user(name, req->name, OCS_MGMT_MAX_NAME)) {
587 ocs_log_test(ocs, "ocs_copy_from_user failed\n");
588 ocs_ioctl_free(ocs, req, sizeof(ocs_ioctl_cmd_get_t));
592 /* Build a text buffer */
593 if (ocs_textbuf_alloc(ocs, &textbuf, req->value_length)) {
594 ocs_log_err(ocs, "Error: ocs_textbuf_alloc failed\n");
598 ocs_mgmt_get(ocs, name, &textbuf);
600 if (ocs_textbuf_get_written(&textbuf)) {
601 if (ocs_copy_to_user(req->value,
602 ocs_textbuf_get_buffer(&textbuf),
603 ocs_textbuf_get_written(&textbuf))) {
604 ocs_log_test(ocs, "Error: (%d) ocs_copy_to_user failed\n", __LINE__);
608 req->value_length = ocs_textbuf_get_written(&textbuf);
610 ocs_textbuf_free(ocs, &textbuf);
615 case OCS_IOCTL_CMD_MGMT_SET: {
616 char name[OCS_MGMT_MAX_NAME];
617 char value[OCS_MGMT_MAX_VALUE];
618 ocs_ioctl_cmd_set_t* req = (ocs_ioctl_cmd_set_t*)addr;
620 // Copy the name in from user space
621 if (ocs_copy_from_user(name, req->name, OCS_MGMT_MAX_NAME)) {
622 ocs_log_test(ocs, "Error: copy from user failed\n");
623 ocs_ioctl_free(ocs, req, sizeof(*req));
627 // Copy the value in from user space
628 if (ocs_copy_from_user(value, req->value, OCS_MGMT_MAX_VALUE)) {
629 ocs_log_test(ocs, "Error: copy from user failed\n");
630 ocs_ioctl_free(ocs, req, sizeof(*req));
634 req->result = ocs_mgmt_set(ocs, req->name, req->value);
639 case OCS_IOCTL_CMD_MGMT_EXEC: {
640 ocs_ioctl_action_t* req = (ocs_ioctl_action_t*) addr;
641 char action_name[OCS_MGMT_MAX_NAME];
643 if (ocs_copy_from_user(action_name, req->name, sizeof(action_name))) {
644 ocs_log_test(ocs, "Error: copy req.name from user failed\n");
645 ocs_ioctl_free(ocs, req, sizeof(*req));
649 req->result = ocs_mgmt_exec(ocs, action_name, req->arg_in, req->arg_in_length,
650 req->arg_out, req->arg_out_length);
656 ocs_log_test(ocs, "Error: unknown cmd %#lx\n", cmd);
664 ocs_fw_write_cb(int32_t status, uint32_t actual_write_length,
665 uint32_t change_status, void *arg)
667 ocs_mgmt_fw_write_result_t *result = arg;
669 result->status = status;
670 result->actual_xfer = actual_write_length;
671 result->change_status = change_status;
673 ocs_sem_v(&(result->semaphore));
677 ocs_firmware_write(ocs_t *ocs, const uint8_t *buf, size_t buf_len,
678 uint8_t *change_status)
686 ocs_mgmt_fw_write_result_t result;
688 ocs_sem_init(&(result.semaphore), 0, "fw_write");
690 bytes_left = buf_len;
693 if (ocs_dma_alloc(ocs, &dma, FW_WRITE_BUFSIZE, 4096)) {
694 ocs_log_err(ocs, "ocs_firmware_write: malloc failed\n");
698 while (bytes_left > 0) {
700 if (bytes_left > FW_WRITE_BUFSIZE) {
701 xfer_size = FW_WRITE_BUFSIZE;
703 xfer_size = bytes_left;
706 ocs_memcpy(dma.virt, buf + offset, xfer_size);
708 if (bytes_left == xfer_size) {
712 ocs_hw_firmware_write(&ocs->hw, &dma, xfer_size, offset,
713 last, ocs_fw_write_cb, &result);
715 if (ocs_sem_p(&(result.semaphore), OCS_SEM_FOREVER) != 0) {
720 if (result.actual_xfer == 0 || result.status != 0) {
726 *change_status = result.change_status;
729 bytes_left -= result.actual_xfer;
730 offset += result.actual_xfer;
733 ocs_dma_free(ocs, &dma);
738 ocs_sys_fwupgrade(SYSCTL_HANDLER_ARGS)
740 char file_name[256] = {0};
741 char fw_change_status;
743 ocs_t *ocs = (ocs_t *)arg1;
744 const struct firmware *fw;
745 const struct ocs_hw_grp_hdr *fw_image;
747 rc = sysctl_handle_string(oidp, file_name, sizeof(file_name), req);
748 if (rc || !req->newptr)
751 fw = firmware_get(file_name);
753 device_printf(ocs->dev, "Unable to get Firmware. "
754 "Make sure %s is copied to /boot/modules\n", file_name);
758 fw_image = (const struct ocs_hw_grp_hdr *)fw->data;
760 /* Check if firmware provided is compatible with this particular
762 if ((ocs_be32toh(fw_image->magic_number) != OCS_HW_OBJECT_G5) &&
763 (ocs_be32toh(fw_image->magic_number) != OCS_HW_OBJECT_G6)) {
764 device_printf(ocs->dev,
765 "Invalid FW image found Magic: 0x%x Size: %zu \n",
766 ocs_be32toh(fw_image->magic_number), fw->datasize);
772 if (!strncmp(ocs->fw_version, fw_image->revision,
773 strnlen(fw_image->revision, 16))) {
774 device_printf(ocs->dev, "No update req. "
775 "Firmware is already up to date. \n");
780 device_printf(ocs->dev, "Upgrading Firmware from %s to %s \n",
781 ocs->fw_version, fw_image->revision);
783 rc = ocs_firmware_write(ocs, fw->data, fw->datasize, &fw_change_status);
785 ocs_log_err(ocs, "Firmware update failed with status = %d\n", rc);
787 ocs_log_info(ocs, "Firmware updated successfully\n");
788 switch (fw_change_status) {
790 device_printf(ocs->dev,
791 "No reset needed, new firmware is active.\n");
794 device_printf(ocs->dev,
795 "A physical device reset (host reboot) is "
796 "needed to activate the new firmware\n");
800 device_printf(ocs->dev,
801 "firmware is resetting to activate the new "
802 "firmware, Host reboot is needed \n");
806 "Unexected value change_status: %d\n",
814 /* Release Firmware*/
815 firmware_put(fw, FIRMWARE_UNLOAD);
822 ocs_sysctl_wwnn(SYSCTL_HANDLER_ARGS)
825 ocs_t *ocs = oidp->oid_arg1;
828 uint64_t *wwnn = NULL;
829 ocs_xport_t *xport = ocs->xport;
831 if (xport->req_wwnn) {
832 wwnn = &xport->req_wwnn;
833 memset(old, 0, sizeof(old));
834 snprintf(old, sizeof(old), "0x%llx" , (unsigned long long) *wwnn);
837 wwnn = ocs_hw_get_ptr(&ocs->hw, OCS_HW_WWN_NODE);
839 memset(old, 0, sizeof(old));
840 snprintf(old, sizeof(old), "0x%llx" , (unsigned long long) ocs_htobe64(*wwnn));
846 return (sysctl_handle_string(oidp, old, sizeof(old), req));
849 /*Configure port wwn*/
850 rc = sysctl_handle_string(oidp, new, sizeof(new), req);
854 if (strncmp(old, new, strlen(old)) == 0) {
858 return (set_req_wwnn(ocs, NULL, new));
862 ocs_sysctl_wwpn(SYSCTL_HANDLER_ARGS)
865 ocs_t *ocs = oidp->oid_arg1;
868 uint64_t *wwpn = NULL;
869 ocs_xport_t *xport = ocs->xport;
871 if (xport->req_wwpn) {
872 wwpn = &xport->req_wwpn;
873 memset(old, 0, sizeof(old));
874 snprintf(old, sizeof(old), "0x%llx",(unsigned long long) *wwpn);
876 wwpn = ocs_hw_get_ptr(&ocs->hw, OCS_HW_WWN_PORT);
877 memset(old, 0, sizeof(old));
878 snprintf(old, sizeof(old), "0x%llx",(unsigned long long) ocs_htobe64(*wwpn));
884 return (sysctl_handle_string(oidp, old, sizeof(old), req));
887 /*Configure port wwn*/
888 rc = sysctl_handle_string(oidp, new, sizeof(new), req);
892 if (strncmp(old, new, strlen(old)) == 0) {
896 return (set_req_wwpn(ocs, NULL, new));
900 ocs_sysctl_current_topology(SYSCTL_HANDLER_ARGS)
902 ocs_t *ocs = oidp->oid_arg1;
905 ocs_hw_get(&ocs->hw, OCS_HW_TOPOLOGY, &value);
907 return (sysctl_handle_int(oidp, &value, 0, req));
911 ocs_sysctl_current_speed(SYSCTL_HANDLER_ARGS)
913 ocs_t *ocs = oidp->oid_arg1;
916 ocs_hw_get(&ocs->hw, OCS_HW_LINK_SPEED, &value);
918 return (sysctl_handle_int(oidp, &value, 0, req));
922 ocs_sysctl_config_topology(SYSCTL_HANDLER_ARGS)
925 ocs_t *ocs = oidp->oid_arg1;
930 ocs_hw_get(&ocs->hw, OCS_HW_CONFIG_TOPOLOGY, &old_value);
934 return (sysctl_handle_int(oidp, &old_value, 0, req));
937 /*Configure port wwn*/
938 rc = sysctl_handle_int(oidp, &new_value, 0, req);
942 if (new_value == old_value) {
946 snprintf(buf, sizeof(buf), "%d",new_value);
947 rc = set_configured_topology(ocs, NULL, buf);
952 ocs_sysctl_config_speed(SYSCTL_HANDLER_ARGS)
955 ocs_t *ocs = oidp->oid_arg1;
960 ocs_hw_get(&ocs->hw, OCS_HW_LINK_CONFIG_SPEED, &old_value);
964 return (sysctl_handle_int(oidp, &old_value, 0, req));
967 /*Configure port wwn*/
968 rc = sysctl_handle_int(oidp, &new_value, 0, req);
972 if (new_value == old_value) {
976 snprintf(buf, sizeof(buf), "%d",new_value);
977 rc = set_configured_speed(ocs, NULL,buf);
982 ocs_sysctl_fcid(SYSCTL_HANDLER_ARGS)
984 ocs_t *ocs = oidp->oid_arg1;
987 memset(buf, 0, sizeof(buf));
988 if (ocs->domain && ocs->domain->attached) {
989 snprintf(buf, sizeof(buf), "0x%06x",
990 ocs->domain->sport->fc_id);
993 return (sysctl_handle_string(oidp, buf, sizeof(buf), req));
998 ocs_sysctl_port_state(SYSCTL_HANDLER_ARGS)
1001 char new[256] = {0};
1003 ocs_xport_stats_t old;
1004 ocs_t *ocs = (ocs_t *)arg1;
1006 ocs_xport_status(ocs->xport, OCS_XPORT_CONFIG_PORT_STATUS, &old);
1008 /*Read port state */
1010 snprintf(new, sizeof(new), "%s",
1011 (old.value == OCS_XPORT_PORT_OFFLINE) ?
1012 "offline" : "online");
1013 return (sysctl_handle_string(oidp, new, sizeof(new), req));
1016 /*Configure port state*/
1017 rc = sysctl_handle_string(oidp, new, sizeof(new), req);
1021 if (ocs_strcasecmp(new, "offline") == 0) {
1022 if (old.value == OCS_XPORT_PORT_OFFLINE) {
1025 ocs_log_debug(ocs, "Setting port to %s\n", new);
1026 rc = ocs_xport_control(ocs->xport, OCS_XPORT_PORT_OFFLINE);
1028 ocs_log_err(ocs, "Setting port to offline failed\n");
1030 } else if (ocs_strcasecmp(new, "online") == 0) {
1031 if (old.value == OCS_XPORT_PORT_ONLINE) {
1034 ocs_log_debug(ocs, "Setting port to %s\n", new);
1035 rc = ocs_xport_control(ocs->xport, OCS_XPORT_PORT_ONLINE);
1037 ocs_log_err(ocs, "Setting port to online failed\n");
1040 ocs_log_err(ocs, "Unsupported link state %s\n", new);
1049 ocs_sysctl_vport_wwpn(SYSCTL_HANDLER_ARGS)
1051 ocs_fcport *fcp = oidp->oid_arg1;
1054 memset(str_wwpn, 0, sizeof(str_wwpn));
1055 snprintf(str_wwpn, sizeof(str_wwpn), "0x%llx", (unsigned long long)fcp->vport->wwpn);
1057 return (sysctl_handle_string(oidp, str_wwpn, sizeof(str_wwpn), req));
1061 ocs_sysctl_vport_wwnn(SYSCTL_HANDLER_ARGS)
1063 ocs_fcport *fcp = oidp->oid_arg1;
1066 memset(str_wwnn, 0, sizeof(str_wwnn));
1067 snprintf(str_wwnn, sizeof(str_wwnn), "0x%llx", (unsigned long long)fcp->vport->wwnn);
1069 return (sysctl_handle_string(oidp, str_wwnn, sizeof(str_wwnn), req));
1073 * @brief Initialize sysctl
1075 * Initialize sysctl so elxsdkutil can query device information.
1077 * @param ocs pointer to ocs
1081 ocs_sysctl_init(ocs_t *ocs)
1083 struct sysctl_ctx_list *ctx = device_get_sysctl_ctx(ocs->dev);
1084 struct sysctl_oid *tree = device_get_sysctl_tree(ocs->dev);
1085 struct sysctl_oid *vtree;
1086 const char *str = NULL;
1088 uint32_t rev, if_type, family, i;
1089 ocs_fcport *fcp = NULL;
1091 SYSCTL_ADD_UINT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1092 "devid", CTLFLAG_RD, NULL,
1093 pci_get_devid(ocs->dev), "Device ID");
1095 memset(ocs->modeldesc, 0, sizeof(ocs->modeldesc));
1096 if (0 == pci_get_vpd_ident(ocs->dev, &str)) {
1097 snprintf(ocs->modeldesc, sizeof(ocs->modeldesc), "%s", str);
1099 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1100 "modeldesc", CTLFLAG_RD,
1102 0, "Model Description");
1104 memset(ocs->serialnum, 0, sizeof(ocs->serialnum));
1105 if (0 == pci_get_vpd_readonly(ocs->dev, "SN", &str)) {
1106 snprintf(ocs->serialnum, sizeof(ocs->serialnum), "%s", str);
1108 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1111 0, "Serial Number");
1113 ocs_hw_get(&ocs->hw, OCS_HW_SLI_REV, &rev);
1114 ocs_hw_get(&ocs->hw, OCS_HW_IF_TYPE, &if_type);
1115 ocs_hw_get(&ocs->hw, OCS_HW_SLI_FAMILY, &family);
1117 memset(ocs->fwrev, 0, sizeof(ocs->fwrev));
1118 snprintf(ocs->fwrev, sizeof(ocs->fwrev), "%s, sli-%d:%d:%x",
1119 (char *)ocs_hw_get_ptr(&ocs->hw, OCS_HW_FW_REV),
1120 rev, if_type, family);
1121 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1122 "fwrev", CTLFLAG_RD,
1124 0, "Firmware Revision");
1126 memset(ocs->sli_intf, 0, sizeof(ocs->sli_intf));
1127 snprintf(ocs->sli_intf, sizeof(ocs->sli_intf), "%08x",
1128 ocs_config_read32(ocs, SLI4_INTF_REG));
1129 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1130 "sli_intf", CTLFLAG_RD,
1132 0, "SLI Interface");
1134 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, "fw_upgrade",
1135 CTLTYPE_STRING | CTLFLAG_RW, (void *)ocs, 0,
1136 ocs_sys_fwupgrade, "A", "Firmware grp file");
1138 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1139 "wwnn", CTLTYPE_STRING | CTLFLAG_RW,
1140 ocs, 0, ocs_sysctl_wwnn, "A",
1141 "World Wide Node Name, wwnn should be in the format 0x<XXXXXXXXXXXXXXXX>");
1143 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1144 "wwpn", CTLTYPE_STRING | CTLFLAG_RW,
1145 ocs, 0, ocs_sysctl_wwpn, "A",
1146 "World Wide Port Name, wwpn should be in the format 0x<XXXXXXXXXXXXXXXX>");
1148 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1149 "current_topology", CTLTYPE_UINT | CTLFLAG_RD,
1150 ocs, 0, ocs_sysctl_current_topology, "IU",
1151 "Current Topology, 1-NPort; 2-Loop; 3-None");
1153 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1154 "current_speed", CTLTYPE_UINT | CTLFLAG_RD,
1155 ocs, 0, ocs_sysctl_current_speed, "IU",
1158 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1159 "configured_topology", CTLTYPE_UINT | CTLFLAG_RW,
1160 ocs, 0, ocs_sysctl_config_topology, "IU",
1161 "Configured Topology, 0-Auto; 1-NPort; 2-Loop");
1163 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1164 "configured_speed", CTLTYPE_UINT | CTLFLAG_RW,
1165 ocs, 0, ocs_sysctl_config_speed, "IU",
1166 "Configured Speed, 0-Auto, 2000, 4000, 8000, 16000, 32000");
1168 SYSCTL_ADD_STRING(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1169 "businfo", CTLFLAG_RD,
1173 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1174 "fcid", CTLTYPE_STRING | CTLFLAG_RD,
1175 ocs, 0, ocs_sysctl_fcid, "A",
1178 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
1179 "port_state", CTLTYPE_STRING | CTLFLAG_RW,
1180 ocs, 0, ocs_sysctl_port_state, "A",
1181 "configured port state");
1183 for (i = 0; i < ocs->num_vports; i++) {
1184 fcp = FCPORT(ocs, i+1);
1186 memset(name, 0, sizeof(name));
1187 snprintf(name, sizeof(name), "vport%d", i);
1188 vtree = SYSCTL_ADD_NODE(ctx, SYSCTL_CHILDREN(tree),
1189 OID_AUTO, name, CTLFLAG_RW, 0, "Virtual port");
1191 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(vtree), OID_AUTO,
1192 "wwnn", CTLTYPE_STRING | CTLFLAG_RW,
1193 fcp, 0, ocs_sysctl_vport_wwnn, "A",
1194 "World Wide Node Name");
1196 SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(vtree), OID_AUTO,
1197 "wwpn", CTLTYPE_STRING | CTLFLAG_RW,
1198 fcp, 0, ocs_sysctl_vport_wwpn, "A",
1199 "World Wide Port Name");
1206 * @brief Initialize the debug module
1208 * Parse device hints (similar to Linux module parameters) here. To use,
1210 * kenv hint.ocs.U.P=V
1211 * from the command line replacing U with the unit # (0,1,...),
1212 * P with the parameter name (debug_mask), and V with the value
1215 ocs_debug_attach(void *os)
1217 struct ocs_softc *ocs = os;
1219 char *resname = NULL;
1220 int32_t unit = INT32_MAX;
1221 uint32_t ocs_debug_mask = 0;
1223 resname = "debug_mask";
1224 if (0 == (error = resource_int_value(device_get_name(ocs->dev), device_get_unit(ocs->dev),
1225 resname, &ocs_debug_mask))) {
1226 device_printf(ocs->dev, "setting %s to %010x\n", resname, ocs_debug_mask);
1227 ocs_debug_enable(ocs_debug_mask);
1230 unit = device_get_unit(ocs->dev);
1231 ocs->cdev = make_dev(&ocs_cdevsw, unit, UID_ROOT, GID_OPERATOR, 0640,
1234 ocs->cdev->si_drv1 = ocs;
1237 /* initialize sysctl interface */
1238 ocs_sysctl_init(ocs);
1239 mtx_init(&ocs->dbg_lock, "ocs_dbg_lock", NULL, MTX_DEF);
1243 * @brief Free the debug module
1246 ocs_debug_detach(void *os)
1248 struct ocs_softc *ocs = os;
1250 mtx_destroy(&ocs->dbg_lock);
1253 ocs->cdev->si_drv1 = NULL;
1254 destroy_dev(ocs->cdev);